<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.4"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Flow-IPC: session/session_server.hpp Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr id="projectrow">
  <td id="projectalign">
   <div id="projectname">Flow-IPC<span id="projectnumber">&#160;1.0.2</span>
   </div>
   <div id="projectbrief">Flow-IPC project: Full implementation reference.</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.4 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search",'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="dir_938858dd290fe54e59e3500689c41d32.html">session</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="headertitle"><div class="title">session_server.hpp</div></div>
</div><!--header-->
<div class="contents">
<a href="ipc__session_2src_2ipc_2session_2session__server_8hpp.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno">    1</span><span class="comment">/* Flow-IPC: Sessions</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno">    2</span><span class="comment"> * Copyright 2023 Akamai Technologies, Inc.</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno">    3</span><span class="comment"> *</span></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno">    4</span><span class="comment"> * Licensed under the Apache License, Version 2.0 (the</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno">    5</span><span class="comment"> * &quot;License&quot;); you may not use this file except in</span></div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno">    6</span><span class="comment"> * compliance with the License.  You may obtain a copy</span></div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno">    7</span><span class="comment"> * of the License at</span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno">    8</span><span class="comment"> *</span></div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno">    9</span><span class="comment"> *   https://www.apache.org/licenses/LICENSE-2.0</span></div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno">   10</span><span class="comment"> *</span></div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno">   11</span><span class="comment"> * Unless required by applicable law or agreed to in</span></div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno">   12</span><span class="comment"> * writing, software distributed under the License is</span></div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno">   13</span><span class="comment"> * distributed on an &quot;AS IS&quot; BASIS, WITHOUT WARRANTIES OR</span></div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno">   14</span><span class="comment"> * CONDITIONS OF ANY KIND, either express or implied.</span></div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno">   15</span><span class="comment"> * See the License for the specific language governing</span></div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno">   16</span><span class="comment"> * permissions and limitations under the License. */</span></div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno">   17</span><span class="comment"></span> </div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno">   18</span><span class="comment">/// @file</span></div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno">   19</span><span class="comment"></span><span class="preprocessor">#pragma once</span></div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno">   20</span> </div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno">   21</span><span class="preprocessor">#include &quot;<a class="code" href="ipc__session_2src_2ipc_2session_2server__session_8hpp.html">ipc/session/server_session.hpp</a>&quot;</span></div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno">   22</span><span class="preprocessor">#include &quot;<a class="code" href="session__server__impl_8hpp.html">ipc/session/detail/session_server_impl.hpp</a>&quot;</span></div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno">   23</span> </div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno">   24</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespaceipc_1_1session.html">ipc::session</a></div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno">   25</span>{</div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno">   26</span> </div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno">   27</span><span class="comment">// Types.</span></div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno">   28</span><span class="comment"></span> </div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno">   29</span><span class="comment">/**</span></div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno">   30</span><span class="comment"> * To be instantiated typically once in a given process, an object of this type asynchronously listens for</span></div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno">   31</span><span class="comment"> * Client_app processes each of which wishes to establish a *session* with this server process;</span></div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno">   32</span><span class="comment"> * emits resulting Server_session objects locally.</span></div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno">   33</span><span class="comment"> *</span></div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno">   34</span><span class="comment"> * ### When to use ###</span></div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno">   35</span><span class="comment"> * In the ipc::session paradigm: See #Server_session doc header &quot;When to use&quot; section.  If and only if,</span></div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno">   36</span><span class="comment"> * based on that text, you wish to use this application to instantiate `Server_session`s, then you must</span></div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno">   37</span><span class="comment"> * instantiate a single Session_server to emit them.  (It is not possible to directly construct</span></div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno">   38</span><span class="comment"> * a PEER-state -- i.e., at all useful -- #Server_session.)</span></div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno">   39</span><span class="comment"> *</span></div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno">   40</span><span class="comment"> * Note that while in a typical (non-test/debug) scenario one would only instantiate a single</span></div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno">   41</span><span class="comment"> * Session_server, that does *not* mean it cannot or should not instantiate `Client_session`s as well.</span></div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno">   42</span><span class="comment"> * In a *given* split, a given application is either the server or the client; but in a different split it</span></div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno">   43</span><span class="comment"> * be the other thing.  So a Session_server handles all the splits in which this application is the</span></div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno">   44</span><span class="comment"> * server; but for other splits one would instantiate 0+ `Client_session`s separately.</span></div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno">   45</span><span class="comment"> *</span></div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno">   46</span><span class="comment"> * ### How to use ###</span></div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno">   47</span><span class="comment"> * Similarly to transport::Native_socket_stream_acceptor constructing `*this` immediately async-listens to</span></div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno">   48</span><span class="comment"> * incoming connections (each an attempt to establish a opposing Client_session to partner with a new local</span></div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno">   49</span><span class="comment"> * #Server_session).  async_accept() shall accept such connections, one at a time, in FIFO order (including any</span></div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno">   50</span><span class="comment"> * that may have queued up in the meantime, including after mere construction).  The meaning of FIFO order</span></div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno">   51</span><span class="comment"> * is discussed below.</span></div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno">   52</span><span class="comment"> *</span></div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno">   53</span><span class="comment"> * Once a #Server_session is emitted to a handler passed to async_accept(), refer to #Server_session doc header</span></div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno">   54</span><span class="comment"> * for how to operate it.  Spoiler alert: you must still call `Server_session::init_handlers()`; at which point</span></div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno">   55</span><span class="comment"> * the #Server_session is a Session concept impl in PEER state.</span></div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno">   56</span><span class="comment"> *</span></div>
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno">   57</span><span class="comment"> * ### Error handling ###</span></div>
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno">   58</span><span class="comment"> * The model followed is the typical boost.asio-like one: Each async_accept() takes a handler, F, and it is</span></div>
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno">   59</span><span class="comment"> * eventually invoked no matter what: either with a falsy (success) #Error_code, or with a truthy (fail) one.</span></div>
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno">   60</span><span class="comment"> * If the op does not complete, and one invokes the `*this` dtor, then `F()` is invoked at dtor time with</span></div>
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno">   61</span><span class="comment"> * a particular operation-aborted #Error_code.</span></div>
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno">   62</span><span class="comment"> *</span></div>
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno">   63</span><span class="comment"> * That said, unlike with (say) transport::Native_socket_stream_acceptor -- and many other classes in ::ipc</span></div>
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno">   64</span><span class="comment"> * and boost.asio -- the failure of a given async_accept() does *not* formally hose `*this`.  Formally,</span></div>
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno">   65</span><span class="comment"> * other async_accept(), including future ones, may succeed.  Rationale:</span></div>
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno">   66</span><span class="comment"> *   - The high-level nature of this class is such that it seemed important to not disregard failed incoming</span></div>
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno">   67</span><span class="comment"> *     connect attempts by simply not emitting them.  The user might monitor/report based on the nature</span></div>
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno">   68</span><span class="comment"> *     of each problematic one.  In particular, log-in failures are of interest w/r/t safety + security.</span></div>
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno">   69</span><span class="comment"> *   - Given that point, there is no reason to necessarily hose the entire IPC framework for this process (as a</span></div>
<div class="line"><a id="l00070" name="l00070"></a><span class="lineno">   70</span><span class="comment"> *     server) due to one badly behaving opposing client.</span></div>
<div class="line"><a id="l00071" name="l00071"></a><span class="lineno">   71</span><span class="comment"> *   - Is is unlikely that a Unix domain socket listener will fail, if it was able to begin listening.</span></div>
<div class="line"><a id="l00072" name="l00072"></a><span class="lineno">   72</span><span class="comment"> *     So post-ctor problems are unlikely to occur strictly before the log-in exchange procedure.</span></div>
<div class="line"><a id="l00073" name="l00073"></a><span class="lineno">   73</span><span class="comment"> *</span></div>
<div class="line"><a id="l00074" name="l00074"></a><span class="lineno">   74</span><span class="comment"> * Informally there are a few ways one could deal with each given error.</span></div>
<div class="line"><a id="l00075" name="l00075"></a><span class="lineno">   75</span><span class="comment"> *   - Simply treating *any* failed async_accept() as `*this`-hosing may well be reasonable.  If something</span></div>
<div class="line"><a id="l00076" name="l00076"></a><span class="lineno">   76</span><span class="comment"> *     went wrong, perhaps it is safest to exit and let the daemon restart in hopes things will start working.</span></div>
<div class="line"><a id="l00077" name="l00077"></a><span class="lineno">   77</span><span class="comment"> *   - Alternatively one can look for particular #Error_code values.  If it has to do with log-in</span></div>
<div class="line"><a id="l00078" name="l00078"></a><span class="lineno">   78</span><span class="comment"> *     continue trying `async_accept()`s -- perhaps up to a certain number of failures.  If it&#39;s something not</span></div>
<div class="line"><a id="l00079" name="l00079"></a><span class="lineno">   79</span><span class="comment"> *     specifically explainable, revert to the previous bullet point (die, restart).  The possible #Error_code</span></div>
<div class="line"><a id="l00080" name="l00080"></a><span class="lineno">   80</span><span class="comment"> *     values emitted by async_accept() are documented in its doc header.</span></div>
<div class="line"><a id="l00081" name="l00081"></a><span class="lineno">   81</span><span class="comment"> *</span></div>
<div class="line"><a id="l00082" name="l00082"></a><span class="lineno">   82</span><span class="comment"> * As of this writing I (ygoldfel) lack sufficient data in the field to make certain pronouncements.</span></div>
<div class="line"><a id="l00083" name="l00083"></a><span class="lineno">   83</span><span class="comment"> *</span></div>
<div class="line"><a id="l00084" name="l00084"></a><span class="lineno">   84</span><span class="comment"> * ### Relationship with Server_app and Client_app; relationship with file system ###</span></div>
<div class="line"><a id="l00085" name="l00085"></a><span class="lineno">   85</span><span class="comment"> * This class operates at quite a high level; there should be (outside of test/debug) only on of them in a process.</span></div>
<div class="line"><a id="l00086" name="l00086"></a><span class="lineno">   86</span><span class="comment"> * There are some important relationships to understand:</span></div>
<div class="line"><a id="l00087" name="l00087"></a><span class="lineno">   87</span><span class="comment"> *   - This process must be invoked consistently with the description in Server_app as passed to its ctor.</span></div>
<div class="line"><a id="l00088" name="l00088"></a><span class="lineno">   88</span><span class="comment"> *     See Server_app (and therefore App) doc header.  In particular its App::m_exec_path, App::m_user_id,</span></div>
<div class="line"><a id="l00089" name="l00089"></a><span class="lineno">   89</span><span class="comment"> *     App::m_group_id must be consistent with reality.</span></div>
<div class="line"><a id="l00090" name="l00090"></a><span class="lineno">   90</span><span class="comment"> *   - The Client_app::Master_set of all `Client_app`s must be equal between all applications (this one and</span></div>
<div class="line"><a id="l00091" name="l00091"></a><span class="lineno">   91</span><span class="comment"> *     the potential client apps included) in the relevant IPC universe -- equal by value and therefore</span></div>
<div class="line"><a id="l00092" name="l00092"></a><span class="lineno">   92</span><span class="comment"> *     with the same key set (key = App::m_name).</span></div>
<div class="line"><a id="l00093" name="l00093"></a><span class="lineno">   93</span><span class="comment"> *   - Similarly for Server_app::Master_set of all `Server_app`s.</span></div>
<div class="line"><a id="l00094" name="l00094"></a><span class="lineno">   94</span><span class="comment"> *   - Server_app::m_allowed_client_apps shall list all `Client_app`s that may indeed open sessions against</span></div>
<div class="line"><a id="l00095" name="l00095"></a><span class="lineno">   95</span><span class="comment"> *     this application.  Any other attempts will be rejected.</span></div>
<div class="line"><a id="l00096" name="l00096"></a><span class="lineno">   96</span><span class="comment"> *     - Furthermore each given client app instance (process) will need to know certain address information about</span></div>
<div class="line"><a id="l00097" name="l00097"></a><span class="lineno">   97</span><span class="comment"> *       this server process so as to connect to the right guy (not just application but instance -- e.g., to not</span></div>
<div class="line"><a id="l00098" name="l00098"></a><span class="lineno">   98</span><span class="comment"> *       connect to some old/dying/zombified instance).  While details are intentionally internal there is an</span></div>
<div class="line"><a id="l00099" name="l00099"></a><span class="lineno">   99</span><span class="comment"> *       interaction with the file system that you should know: The datum internally known as the *server app namespace*</span></div>
<div class="line"><a id="l00100" name="l00100"></a><span class="lineno">  100</span><span class="comment"> *       is the key thing that varies from instance to instance.  It is, in fact, the PID (process ID) which has</span></div>
<div class="line"><a id="l00101" name="l00101"></a><span class="lineno">  101</span><span class="comment"> *       good uniqueness properties.  This is saved in the so-called Current Namespace Store (CNS) which is</span></div>
<div class="line"><a id="l00102" name="l00102"></a><span class="lineno">  102</span><span class="comment"> *       simply a PID file, a fairly typical construct in Unix daemons.  Therefore:</span></div>
<div class="line"><a id="l00103" name="l00103"></a><span class="lineno">  103</span><span class="comment"> *       - Session_server writes this in its ctor.</span></div>
<div class="line"><a id="l00104" name="l00104"></a><span class="lineno">  104</span><span class="comment"> *       - The name is, as of this writing, X.pid, where X is Server_app::m_name.</span></div>
<div class="line"><a id="l00105" name="l00105"></a><span class="lineno">  105</span><span class="comment"> *       - The location is either a sensible default (/var/run as of this writing) or an override path</span></div>
<div class="line"><a id="l00106" name="l00106"></a><span class="lineno">  106</span><span class="comment"> *         Server_app::m_kernel_persistent_run_dir_override.  (Reminder: the same `Server_app`s, by value, must</span></div>
<div class="line"><a id="l00107" name="l00107"></a><span class="lineno">  107</span><span class="comment"> *         be registered in all processes, whether client or server or both.  Hence this override will be</span></div>
<div class="line"><a id="l00108" name="l00108"></a><span class="lineno">  108</span><span class="comment"> *         agreed-upon on both sides.)</span></div>
<div class="line"><a id="l00109" name="l00109"></a><span class="lineno">  109</span><span class="comment"> *       - Client_session::sync_connect() shall check this file immediately to know to which server process --</span></div>
<div class="line"><a id="l00110" name="l00110"></a><span class="lineno">  110</span><span class="comment"> *         Session_server -- to connect.</span></div>
<div class="line"><a id="l00111" name="l00111"></a><span class="lineno">  111</span><span class="comment"> *</span></div>
<div class="line"><a id="l00112" name="l00112"></a><span class="lineno">  112</span><span class="comment"> * As of this writing we expect Session_server to be in charge of maintaining the process&#39;s only</span></div>
<div class="line"><a id="l00113" name="l00113"></a><span class="lineno">  113</span><span class="comment"> * PID file, in the sense that a typical daemon is expected to maintain a general-use PID file, with the usual</span></div>
<div class="line"><a id="l00114" name="l00114"></a><span class="lineno">  114</span><span class="comment"> * format (where the file contains a decimal encoding of the PID plus a newline).  If this</span></div>
<div class="line"><a id="l00115" name="l00115"></a><span class="lineno">  115</span><span class="comment"> * is not acceptable -- i.e., we don&#39;t want the ::ipc system to &quot;step&quot; on some other mechanism for PID files</span></div>
<div class="line"><a id="l00116" name="l00116"></a><span class="lineno">  116</span><span class="comment"> * already in use -- then the location may be tweaked, at least via Server_app::m_kernel_persistent_run_dir_override</span></div>
<div class="line"><a id="l00117" name="l00117"></a><span class="lineno">  117</span><span class="comment"> * or possibly with a different default than the current choice (/var/run).</span></div>
<div class="line"><a id="l00118" name="l00118"></a><span class="lineno">  118</span><span class="comment"> *</span></div>
<div class="line"><a id="l00119" name="l00119"></a><span class="lineno">  119</span><span class="comment"> * ### Thread safety; handler invocation ###</span></div>
<div class="line"><a id="l00120" name="l00120"></a><span class="lineno">  120</span><span class="comment"> * After construction of `*this`, concurrent access to API methods and the dtor is not safe, unless all methods</span></div>
<div class="line"><a id="l00121" name="l00121"></a><span class="lineno">  121</span><span class="comment"> * being invoked concurrently are `const`.</span></div>
<div class="line"><a id="l00122" name="l00122"></a><span class="lineno">  122</span><span class="comment"> *</span></div>
<div class="line"><a id="l00123" name="l00123"></a><span class="lineno">  123</span><span class="comment"> * You *may* invoke async_accept() directly from within another async_accept()-passed handler.</span></div>
<div class="line"><a id="l00124" name="l00124"></a><span class="lineno">  124</span><span class="comment"> * (Informally we suggest you post all real handling onto your own thread(s).)</span></div>
<div class="line"><a id="l00125" name="l00125"></a><span class="lineno">  125</span><span class="comment"> *</span></div>
<div class="line"><a id="l00126" name="l00126"></a><span class="lineno">  126</span><span class="comment"> * However: async_accept()-passed user handlers may be invoked *concurrently to each other* (if 2+ async_accept()s are</span></div>
<div class="line"><a id="l00127" name="l00127"></a><span class="lineno">  127</span><span class="comment"> * outstanding).  It is your responsibility, then, to ensure you do not invoke 2+ async_accept()s concurrently.</span></div>
<div class="line"><a id="l00128" name="l00128"></a><span class="lineno">  128</span><span class="comment"> * (One way is to only have only 1 outstanding at any given time.  Another is to post all handling on your own thread.</span></div>
<div class="line"><a id="l00129" name="l00129"></a><span class="lineno">  129</span><span class="comment"> * Really informally we&#39;d say it&#39;s best to do both.)</span></div>
<div class="line"><a id="l00130" name="l00130"></a><span class="lineno">  130</span><span class="comment"> *</span></div>
<div class="line"><a id="l00131" name="l00131"></a><span class="lineno">  131</span><span class="comment"> * ### Subtlety about &quot;FIFO order&quot; w/r/t async_accept() ###</span></div>
<div class="line"><a id="l00132" name="l00132"></a><span class="lineno">  132</span><span class="comment"> * Above we promise that async_accept() shall emit ready `Server_sessions`s in &quot;FIFO&quot; order.  The following</span></div>
<div class="line"><a id="l00133" name="l00133"></a><span class="lineno">  133</span><span class="comment"> * expands on that, for completeness, even though it is unlikely a typical user will care.  The FIFO order is subtly</span></div>
<div class="line"><a id="l00134" name="l00134"></a><span class="lineno">  134</span><span class="comment"> * different from that in, say, `Native_socket_stream_acceptor` or boost.asio&#39;s</span></div>
<div class="line"><a id="l00135" name="l00135"></a><span class="lineno">  135</span><span class="comment"> * transport::asio_local_stream_socket::Acceptor.  To wit:</span></div>
<div class="line"><a id="l00136" name="l00136"></a><span class="lineno">  136</span><span class="comment"> *</span></div>
<div class="line"><a id="l00137" name="l00137"></a><span class="lineno">  137</span><span class="comment"> * Suppose async-accept request R1 was followed by R2.  As a black box, it is possible that the handler for</span></div>
<div class="line"><a id="l00138" name="l00138"></a><span class="lineno">  138</span><span class="comment"> * R2 will fire before the handler for R1.  I.e., the &quot;first out&quot; refers to something different than</span></div>
<div class="line"><a id="l00139" name="l00139"></a><span class="lineno">  139</span><span class="comment"> * the order of emission.  Rather: each given request R consists of 2 steps internally (listed here in the</span></div>
<div class="line"><a id="l00140" name="l00140"></a><span class="lineno">  140</span><span class="comment"> * public section only for exposition):</span></div>
<div class="line"><a id="l00141" name="l00141"></a><span class="lineno">  141</span><span class="comment"> *   -# Accept a Unix domain socket connection.  Immediately upon it being accepted:</span></div>
<div class="line"><a id="l00142" name="l00142"></a><span class="lineno">  142</span><span class="comment"> *   -# Execute a log-in exchange on that connection, including things like Client_app identification and verification</span></div>
<div class="line"><a id="l00143" name="l00143"></a><span class="lineno">  143</span><span class="comment"> *      and a session token thing.</span></div>
<div class="line"><a id="l00144" name="l00144"></a><span class="lineno">  144</span><span class="comment"> *</span></div>
<div class="line"><a id="l00145" name="l00145"></a><span class="lineno">  145</span><span class="comment"> * The &quot;FIFO order&quot; refers to the first step.  Request R1 shall indeed handle the first incoming socket connection;</span></div>
<div class="line"><a id="l00146" name="l00146"></a><span class="lineno">  146</span><span class="comment"> * R2 the second: first-come, first-served.  However, the log-in exchange must still occur.  In practice this</span></div>
<div class="line"><a id="l00147" name="l00147"></a><span class="lineno">  147</span><span class="comment"> * should be quite quick: Client_session will immediately ping us, and we&#39;ll ping them back, and that&#39;s that.</span></div>
<div class="line"><a id="l00148" name="l00148"></a><span class="lineno">  148</span><span class="comment"> * However, it is possible that (for whatever reason) R2 will win the race against R1 despite a head start for</span></div>
<div class="line"><a id="l00149" name="l00149"></a><span class="lineno">  149</span><span class="comment"> * the latter.  Therefore, it won&#39;t look quite like FIFO, though probably it will -- and if not, then close enough.</span></div>
<div class="line"><a id="l00150" name="l00150"></a><span class="lineno">  150</span><span class="comment"> *</span></div>
<div class="line"><a id="l00151" name="l00151"></a><span class="lineno">  151</span><span class="comment"> * Rationale: Honestly: It really has to do with simplicity of implementation (discussed in the impl section below but</span></div>
<div class="line"><a id="l00152" name="l00152"></a><span class="lineno">  152</span><span class="comment"> * of little interest to the user and not included in the public-API Doxygen-generated docs).  Implementing it</span></div>
<div class="line"><a id="l00153" name="l00153"></a><span class="lineno">  153</span><span class="comment"> * that way was simpler and easier to maintain; probably the perf less latent too.  The fact that, as a result,</span></div>
<div class="line"><a id="l00154" name="l00154"></a><span class="lineno">  154</span><span class="comment"> * the FIFO order might get sometimes switched around did not seem important in practice.  Still it is worth</span></div>
<div class="line"><a id="l00155" name="l00155"></a><span class="lineno">  155</span><span class="comment"> * remarking upon formally.</span></div>
<div class="line"><a id="l00156" name="l00156"></a><span class="lineno">  156</span><span class="comment"> *</span></div>
<div class="line"><a id="l00157" name="l00157"></a><span class="lineno">  157</span><span class="comment"> * Informally: are there any practical concerns about this for the user?  It seems unlikely.  It is, one supposes,</span></div>
<div class="line"><a id="l00158" name="l00158"></a><span class="lineno">  158</span><span class="comment"> * sort-of conceivable that some system would rely on the ordering of incoming sessions being requested to be</span></div>
<div class="line"><a id="l00159" name="l00159"></a><span class="lineno">  159</span><span class="comment"> * significant in some larger inter-application algorithm.  However, 1, that sounds highly unorthodox to put it mildly</span></div>
<div class="line"><a id="l00160" name="l00160"></a><span class="lineno">  160</span><span class="comment"> * (more like an abuse of the ipc::session system&#39;s versus its intended usefulness); and 2, even then one could then</span></div>
<div class="line"><a id="l00161" name="l00161"></a><span class="lineno">  161</span><span class="comment"> * simply issue async_accept() R2 upon the success of async_accept() R1, if an ordering guarantee is really required.</span></div>
<div class="line"><a id="l00162" name="l00162"></a><span class="lineno">  162</span><span class="comment"> *</span></div>
<div class="line"><a id="l00163" name="l00163"></a><span class="lineno">  163</span><span class="comment"> * @internal</span></div>
<div class="line"><a id="l00164" name="l00164"></a><span class="lineno">  164</span><span class="comment"> * ### Implementation ###</span></div>
<div class="line"><a id="l00165" name="l00165"></a><span class="lineno">  165</span><span class="comment"> * Internally Session_server is really its `private` base: Session_server_impl parameterized</span></div>
<div class="line"><a id="l00166" name="l00166"></a><span class="lineno">  166</span><span class="comment"> * on the vanilla #Server_session_obj it produces.  See impl notes for that internal class template.</span></div>
<div class="line"><a id="l00167" name="l00167"></a><span class="lineno">  167</span><span class="comment"> * 100% of the work done by `*this` is done by that base.  Why does the base exist then?  Answer:</span></div>
<div class="line"><a id="l00168" name="l00168"></a><span class="lineno">  168</span><span class="comment"> * to implement Session_server variants with added capabilities, including the capability of producing</span></div>
<div class="line"><a id="l00169" name="l00169"></a><span class="lineno">  169</span><span class="comment"> * non-vanilla #Server_session variants.  For example: shm::classic::Session_server:</span></div>
<div class="line"><a id="l00170" name="l00170"></a><span class="lineno">  170</span><span class="comment"> *   - emits shm::classic::Server_session which is like #Server_session but with its own per-session boost.ipc.shm SHM</span></div>
<div class="line"><a id="l00171" name="l00171"></a><span class="lineno">  171</span><span class="comment"> *     pool-based arena;</span></div>
<div class="line"><a id="l00172" name="l00172"></a><span class="lineno">  172</span><span class="comment"> *   - and which also sets up a per-Client_app SHM arena in a boost.ipc.shm SHM pool, for each new distinct Client_app</span></div>
<div class="line"><a id="l00173" name="l00173"></a><span class="lineno">  173</span><span class="comment"> *     to start a session (it creates it if needed by name; and keeps handle open; it&#39;s an atomic operation).</span></div>
<div class="line"><a id="l00174" name="l00174"></a><span class="lineno">  174</span><span class="comment"> *</span></div>
<div class="line"><a id="l00175" name="l00175"></a><span class="lineno">  175</span><span class="comment"> * As for this class template, though, we add no such things, because we:</span></div>
<div class="line"><a id="l00176" name="l00176"></a><span class="lineno">  176</span><span class="comment"> *   - pass-through a no-op `per_app_setup_func()` that always yields falsy #Error_code;</span></div>
<div class="line"><a id="l00177" name="l00177"></a><span class="lineno">  177</span><span class="comment"> *   - emit vanilla Server_session (#Server_session_obj).</span></div>
<div class="line"><a id="l00178" name="l00178"></a><span class="lineno">  178</span><span class="comment"> * @endinternal</span></div>
<div class="line"><a id="l00179" name="l00179"></a><span class="lineno">  179</span><span class="comment"> *</span></div>
<div class="line"><a id="l00180" name="l00180"></a><span class="lineno">  180</span><span class="comment"> * @tparam S_MQ_TYPE_OR_NONE</span></div>
<div class="line"><a id="l00181" name="l00181"></a><span class="lineno">  181</span><span class="comment"> *         Emitted `Server_session`s shall have the concrete typed based on this value for `S_MQ_TYPE_OR_NONE`.</span></div>
<div class="line"><a id="l00182" name="l00182"></a><span class="lineno">  182</span><span class="comment"> *         See #Server_session_obj.</span></div>
<div class="line"><a id="l00183" name="l00183"></a><span class="lineno">  183</span><span class="comment"> * @tparam S_TRANSMIT_NATIVE_HANDLES</span></div>
<div class="line"><a id="l00184" name="l00184"></a><span class="lineno">  184</span><span class="comment"> *         Emitted `Server_session`s shall have the concrete typed based on this value for `S_TRANSMIT_NATIVE_HANDLES`.</span></div>
<div class="line"><a id="l00185" name="l00185"></a><span class="lineno">  185</span><span class="comment"> *         See #Server_session_obj.</span></div>
<div class="line"><a id="l00186" name="l00186"></a><span class="lineno">  186</span><span class="comment"> * @tparam Mdt_payload</span></div>
<div class="line"><a id="l00187" name="l00187"></a><span class="lineno">  187</span><span class="comment"> *         Emitted `Server_session`s shall have the concrete typed based on this value for `Mdt_payload`.</span></div>
<div class="line"><a id="l00188" name="l00188"></a><span class="lineno">  188</span><span class="comment"> *         See #Server_session_obj.  In addition the same type may be used for `mdt_from_cli_or_null` (and srv-&gt;cli</span></div>
<div class="line"><a id="l00189" name="l00189"></a><span class="lineno">  189</span><span class="comment"> *         counterpart) in async_accept().  (Recall that you can use a capnp-`union` internally</span></div>
<div class="line"><a id="l00190" name="l00190"></a><span class="lineno">  190</span><span class="comment"> *         for various purposes.)</span></div>
<div class="line"><a id="l00191" name="l00191"></a><span class="lineno">  191</span><span class="comment"> */</span></div>
<div class="line"><a id="l00192" name="l00192"></a><span class="lineno">  192</span><span class="keyword">template</span>&lt;schema::MqType S_MQ_TYPE_OR_NONE, <span class="keywordtype">bool</span> S_TRANSMIT_NATIVE_HANDLES, <span class="keyword">typename</span> Mdt_payload&gt;</div>
<div class="line"><a id="l00193" name="l00193"></a><span class="lineno"><a class="line" href="classipc_1_1session_1_1Session__server.html">  193</a></span><span class="keyword">class </span><a class="code hl_class" href="classipc_1_1session_1_1Session__server.html">Session_server</a> :</div>
<div class="line"><a id="l00194" name="l00194"></a><span class="lineno">  194</span>  <span class="keyword">private</span> <a class="code hl_class" href="classipc_1_1session_1_1Session__server__impl.html">Session_server_impl</a> <span class="comment">// Attn!  Emit vanilla `Server_session`s (impl customization point: unused).</span></div>
<div class="line"><a id="l00195" name="l00195"></a><span class="lineno">  195</span>            &lt;Session_server&lt;S_MQ_TYPE_OR_NONE, S_TRANSMIT_NATIVE_HANDLES, Mdt_payload&gt;,</div>
<div class="line"><a id="l00196" name="l00196"></a><span class="lineno">  196</span>             Server_session&lt;S_MQ_TYPE_OR_NONE, S_TRANSMIT_NATIVE_HANDLES, Mdt_payload&gt;&gt;</div>
<div class="line"><a id="l00197" name="l00197"></a><span class="lineno">  197</span>{</div>
<div class="line"><a id="l00198" name="l00198"></a><span class="lineno">  198</span><span class="keyword">private</span>:</div>
<div class="line"><a id="l00199" name="l00199"></a><span class="lineno">  199</span>  <span class="comment">// Types.</span></div>
<div class="line"><a id="l00200" name="l00200"></a><span class="lineno">  200</span><span class="comment"></span> </div>
<div class="line"><a id="l00201" name="l00201"></a><span class="lineno">  201</span><span class="comment">  /// Short-hand for our base/core impl.</span></div>
<div class="line"><a id="l00202" name="l00202"></a><span class="lineno"><a class="line" href="classipc_1_1session_1_1Session__server.html#a88662c940c51cbaad4dd2cc8af87b147">  202</a></span><span class="comment"></span>  <span class="keyword">using </span><a class="code hl_class" href="classipc_1_1session_1_1Session__server__impl.html">Impl</a> = <a class="code hl_class" href="classipc_1_1session_1_1Session__server__impl.html">Session_server_impl</a></div>
<div class="line"><a id="l00203" name="l00203"></a><span class="lineno">  203</span>                 &lt;<a class="code hl_class" href="classipc_1_1session_1_1Session__server.html">Session_server&lt;S_MQ_TYPE_OR_NONE, S_TRANSMIT_NATIVE_HANDLES, Mdt_payload&gt;</a>,</div>
<div class="line"><a id="l00204" name="l00204"></a><span class="lineno">  204</span>                  <a class="code hl_class" href="classipc_1_1session_1_1Server__session__mv.html">Server_session&lt;S_MQ_TYPE_OR_NONE, S_TRANSMIT_NATIVE_HANDLES, Mdt_payload&gt;</a>&gt;;</div>
<div class="line"><a id="l00205" name="l00205"></a><span class="lineno">  205</span> </div>
<div class="line"><a id="l00206" name="l00206"></a><span class="lineno">  206</span><span class="keyword">public</span>:</div>
<div class="line"><a id="l00207" name="l00207"></a><span class="lineno">  207</span>  <span class="comment">// Types.</span></div>
<div class="line"><a id="l00208" name="l00208"></a><span class="lineno">  208</span><span class="comment"></span> </div>
<div class="line"><a id="l00209" name="l00209"></a><span class="lineno">  209</span><span class="comment">  /// Short-hand for the concrete `Server_session`-like type emitted by async_accept().</span></div>
<div class="line"><a id="l00210" name="l00210"></a><span class="lineno"><a class="line" href="classipc_1_1session_1_1Session__server.html#a4140ba69205b68aec322ad834f4c8d59">  210</a></span><span class="comment"></span>  <span class="keyword">using </span><a class="code hl_class" href="classipc_1_1session_1_1Server__session__mv.html">Server_session_obj</a> = <a class="code hl_class" href="classipc_1_1session_1_1Server__session__mv.html">Server_session&lt;S_MQ_TYPE_OR_NONE, S_TRANSMIT_NATIVE_HANDLES, Mdt_payload&gt;</a>;</div>
<div class="line"><a id="l00211" name="l00211"></a><span class="lineno">  211</span><span class="comment"></span> </div>
<div class="line"><a id="l00212" name="l00212"></a><span class="lineno">  212</span><span class="comment">  /// Short-hand for Session_mv::Mdt_reader_ptr.</span></div>
<div class="line"><a id="l00213" name="l00213"></a><span class="lineno"><a class="line" href="classipc_1_1session_1_1Session__server.html#aa19b9057ac2d873b5989b6213a9e6f82">  213</a></span><span class="comment"></span>  <span class="keyword">using </span><a class="code hl_typedef" href="classipc_1_1session_1_1Session__server.html#aa19b9057ac2d873b5989b6213a9e6f82">Mdt_reader_ptr</a> = <span class="keyword">typename</span> <a class="code hl_typedef" href="classipc_1_1session_1_1Session__server__impl.html#a86de1d5b7cae35d89827c3235e2b8d89">Impl::Mdt_reader_ptr</a>;</div>
<div class="line"><a id="l00214" name="l00214"></a><span class="lineno">  214</span><span class="comment"></span> </div>
<div class="line"><a id="l00215" name="l00215"></a><span class="lineno">  215</span><span class="comment">  /// Metadata builder type passed to `mdt_load_func()` in advanced async_accept() overload.</span></div>
<div class="line"><a id="l00216" name="l00216"></a><span class="lineno"><a class="line" href="classipc_1_1session_1_1Session__server.html#a86e894429b8568458aa20f3ba814434d">  216</a></span><span class="comment"></span>  <span class="keyword">using </span><a class="code hl_typedef" href="classipc_1_1session_1_1Session__server.html#a86e894429b8568458aa20f3ba814434d">Mdt_builder</a> = <span class="keyword">typename</span> <a class="code hl_typedef" href="classipc_1_1session_1_1Session__mv.html#af10f452e602e4ea7389c6a77dd9a0f88">Server_session_obj::Mdt_builder</a>;</div>
<div class="line"><a id="l00217" name="l00217"></a><span class="lineno">  217</span><span class="comment"></span> </div>
<div class="line"><a id="l00218" name="l00218"></a><span class="lineno">  218</span><span class="comment">  /// Short-hand for Session_mv::Channels.</span></div>
<div class="line"><a id="l00219" name="l00219"></a><span class="lineno"><a class="line" href="classipc_1_1session_1_1Session__server.html#a6dea741c32a771532a884ffbc0826bb3">  219</a></span><span class="comment"></span>  <span class="keyword">using </span><a class="code hl_typedef" href="classipc_1_1session_1_1Session__server.html#a6dea741c32a771532a884ffbc0826bb3">Channels</a> = <span class="keyword">typename</span> <a class="code hl_typedef" href="classipc_1_1session_1_1Session__server__impl.html#a9ad5c6cbb1c9378d42ec5cd909389dc2">Impl::Channels</a>;</div>
<div class="line"><a id="l00220" name="l00220"></a><span class="lineno">  220</span> </div>
<div class="line"><a id="l00221" name="l00221"></a><span class="lineno">  221</span>  <span class="comment">// Constructors/destructor.</span></div>
<div class="line"><a id="l00222" name="l00222"></a><span class="lineno">  222</span><span class="comment"></span> </div>
<div class="line"><a id="l00223" name="l00223"></a><span class="lineno">  223</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00224" name="l00224"></a><span class="lineno">  224</span><span class="comment">   * Constructor: immediately begins listening for incoming session-open attempts from allowed clients.</span></div>
<div class="line"><a id="l00225" name="l00225"></a><span class="lineno">  225</span><span class="comment">   * This will write to the CNS (PID file) and then listen on Unix domain</span></div>
<div class="line"><a id="l00226" name="l00226"></a><span class="lineno">  226</span><span class="comment">   * server socket whose abstract address is based off its contents (as explained in the class doc header).</span></div>
<div class="line"><a id="l00227" name="l00227"></a><span class="lineno">  227</span><span class="comment">   *</span></div>
<div class="line"><a id="l00228" name="l00228"></a><span class="lineno">  228</span><span class="comment">   * If either step fails (file error, address-bind error being the most likely culprits), an error is emitted</span></div>
<div class="line"><a id="l00229" name="l00229"></a><span class="lineno">  229</span><span class="comment">   * via normal Flow error semantics.  If this occurs, via the non-exception-throwing invocation style,</span></div>
<div class="line"><a id="l00230" name="l00230"></a><span class="lineno">  230</span><span class="comment">   * then you must not call async_accept(); or behavior is undefined (assertion may trip).</span></div>
<div class="line"><a id="l00231" name="l00231"></a><span class="lineno">  231</span><span class="comment">   *</span></div>
<div class="line"><a id="l00232" name="l00232"></a><span class="lineno">  232</span><span class="comment">   * @param logger_ptr</span></div>
<div class="line"><a id="l00233" name="l00233"></a><span class="lineno">  233</span><span class="comment">   *        Logger to use for logging subsequently.</span></div>
<div class="line"><a id="l00234" name="l00234"></a><span class="lineno">  234</span><span class="comment">   * @param srv_app_ref</span></div>
<div class="line"><a id="l00235" name="l00235"></a><span class="lineno">  235</span><span class="comment">   *        Properties of this server application.  The address is copied; the object is not copied.</span></div>
<div class="line"><a id="l00236" name="l00236"></a><span class="lineno">  236</span><span class="comment">   * @param cli_app_master_set_ref</span></div>
<div class="line"><a id="l00237" name="l00237"></a><span class="lineno">  237</span><span class="comment">   *        The set of all known `Client_app`s.  The address is copied; the object is not copied.</span></div>
<div class="line"><a id="l00238" name="l00238"></a><span class="lineno">  238</span><span class="comment">   *        Technically, from our POV, it need only list the `Client_app`s whose names are</span></div>
<div class="line"><a id="l00239" name="l00239"></a><span class="lineno">  239</span><span class="comment">   *        in `srv_app_ref.m_allowed_client_apps`.  Refer to App doc header for best practices on</span></div>
<div class="line"><a id="l00240" name="l00240"></a><span class="lineno">  240</span><span class="comment">   *        maintaining this master list in practice.</span></div>
<div class="line"><a id="l00241" name="l00241"></a><span class="lineno">  241</span><span class="comment">   * @param err_code</span></div>
<div class="line"><a id="l00242" name="l00242"></a><span class="lineno">  242</span><span class="comment">   *        See `flow::Error_code` docs for error reporting semantics.  #Error_code generated:</span></div>
<div class="line"><a id="l00243" name="l00243"></a><span class="lineno">  243</span><span class="comment">   *        interprocess-mutex-related errors (probably from boost.interprocess) w/r/t writing the CNS (PID file);</span></div>
<div class="line"><a id="l00244" name="l00244"></a><span class="lineno">  244</span><span class="comment">   *        file-related system errors w/r/t writing the CNS (PID file) (see class doc header for background);</span></div>
<div class="line"><a id="l00245" name="l00245"></a><span class="lineno">  245</span><span class="comment">   *        errors emitted by transport::Native_socket_stream_acceptor ctor (see that ctor&#39;s doc header; but note</span></div>
<div class="line"><a id="l00246" name="l00246"></a><span class="lineno">  246</span><span class="comment">   *        that they comprise name-too-long and name-conflict errors which ipc::session specifically exists to</span></div>
<div class="line"><a id="l00247" name="l00247"></a><span class="lineno">  247</span><span class="comment">   *        avoid, so you need not worry about even the fact there&#39;s an abstract Unix domain socket address involved).</span></div>
<div class="line"><a id="l00248" name="l00248"></a><span class="lineno">  248</span><span class="comment">   */</span></div>
<div class="line"><a id="l00249" name="l00249"></a><span class="lineno">  249</span>  <span class="keyword">explicit</span> <a class="code hl_function" href="classipc_1_1session_1_1Session__server.html#a948ef778f6dd521e0f7632e9f7e06aa7">Session_server</a>(flow::log::Logger* logger_ptr, <span class="keyword">const</span> <a class="code hl_struct" href="structipc_1_1session_1_1Server__app.html">Server_app</a>&amp; srv_app_ref,</div>
<div class="line"><a id="l00250" name="l00250"></a><span class="lineno">  250</span>                          <span class="keyword">const</span> <a class="code hl_typedef" href="structipc_1_1session_1_1Client__app.html#add718cbf6aa1d2abb26fbadcc974a7bd">Client_app::Master_set</a>&amp; cli_app_master_set_ref,</div>
<div class="line"><a id="l00251" name="l00251"></a><span class="lineno">  251</span>                          <a class="code hl_typedef" href="namespaceipc.html#aa3192e586cc45d3e7c22463bf2760f89">Error_code</a>* err_code = 0);</div>
<div class="line"><a id="l00252" name="l00252"></a><span class="lineno">  252</span><span class="comment"></span> </div>
<div class="line"><a id="l00253" name="l00253"></a><span class="lineno">  253</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00254" name="l00254"></a><span class="lineno">  254</span><span class="comment">   * Destroys this acceptor which will stop listening in the background and cancel any pending</span></div>
<div class="line"><a id="l00255" name="l00255"></a><span class="lineno">  255</span><span class="comment">   * completion handlers by invoking them ASAP with</span></div>
<div class="line"><a id="l00256" name="l00256"></a><span class="lineno">  256</span><span class="comment">   * session::error::Code::S_OBJECT_SHUTDOWN_ABORTED_COMPLETION_HANDLER.  Subtlety:</span></div>
<div class="line"><a id="l00257" name="l00257"></a><span class="lineno">  257</span><span class="comment">   * expect session::error::Code::S_OBJECT_SHUTDOWN_ABORTED_COMPLETION_HANDLER, not</span></div>
<div class="line"><a id="l00258" name="l00258"></a><span class="lineno">  258</span><span class="comment">   * transport::error::Code::S_OBJECT_SHUTDOWN_ABORTED_COMPLETION_HANDLER, regardless of the fact</span></div>
<div class="line"><a id="l00259" name="l00259"></a><span class="lineno">  259</span><span class="comment">   * that internally a transport::Native_socket_stream_acceptor is used.</span></div>
<div class="line"><a id="l00260" name="l00260"></a><span class="lineno">  260</span><span class="comment">   *</span></div>
<div class="line"><a id="l00261" name="l00261"></a><span class="lineno">  261</span><span class="comment">   * You must not call this from directly within a completion handler; else undefined behavior.</span></div>
<div class="line"><a id="l00262" name="l00262"></a><span class="lineno">  262</span><span class="comment">   *</span></div>
<div class="line"><a id="l00263" name="l00263"></a><span class="lineno">  263</span><span class="comment">   * Each pending completion handler will be called from an unspecified thread that is not the calling thread.</span></div>
<div class="line"><a id="l00264" name="l00264"></a><span class="lineno">  264</span><span class="comment">   * Any associated captured state for that handler will be freed shortly after the handler returns.</span></div>
<div class="line"><a id="l00265" name="l00265"></a><span class="lineno">  265</span><span class="comment">   *</span></div>
<div class="line"><a id="l00266" name="l00266"></a><span class="lineno">  266</span><span class="comment">   * We informally but very strongly recommend that your completion handler immediately return if the `Error_code`</span></div>
<div class="line"><a id="l00267" name="l00267"></a><span class="lineno">  267</span><span class="comment">   * passed to it is error::Code::S_OBJECT_SHUTDOWN_ABORTED_COMPLETION_HANDLER.  This is similar to what one should</span></div>
<div class="line"><a id="l00268" name="l00268"></a><span class="lineno">  268</span><span class="comment">   * do when using boost.asio and receiving the conceptually identical `operation_aborted` error code to an</span></div>
<div class="line"><a id="l00269" name="l00269"></a><span class="lineno">  269</span><span class="comment">   * `async_...()` completion handler.  In both cases, this condition means, &quot;we have decided to shut this thing down,</span></div>
<div class="line"><a id="l00270" name="l00270"></a><span class="lineno">  270</span><span class="comment">   * so the completion handlers are simply being informed of this.&quot;</span></div>
<div class="line"><a id="l00271" name="l00271"></a><span class="lineno">  271</span><span class="comment">   */</span></div>
<div class="line"><a id="l00272" name="l00272"></a><span class="lineno"><a class="line" href="classipc_1_1session_1_1Session__server.html#ae9c7c3132edba73bfad5d5a90722e813">  272</a></span>  <a class="code hl_function" href="classipc_1_1session_1_1Session__server.html#ae9c7c3132edba73bfad5d5a90722e813">~Session_server</a>();</div>
<div class="line"><a id="l00273" name="l00273"></a><span class="lineno">  273</span> </div>
<div class="line"><a id="l00274" name="l00274"></a><span class="lineno">  274</span>  <span class="comment">// Methods.</span></div>
<div class="line"><a id="l00275" name="l00275"></a><span class="lineno">  275</span><span class="comment"></span> </div>
<div class="line"><a id="l00276" name="l00276"></a><span class="lineno">  276</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00277" name="l00277"></a><span class="lineno">  277</span><span class="comment">   * Asynchronously awaits for an opposing Client_session to request session establishment and calls `on_done_func()`,</span></div>
<div class="line"><a id="l00278" name="l00278"></a><span class="lineno">  278</span><span class="comment">   * once the connection occurs and log-in exchange completes, or an error occurs, in the former case move-assigning an</span></div>
<div class="line"><a id="l00279" name="l00279"></a><span class="lineno">  279</span><span class="comment">   * almost-PEER-state Server_session object to the passed-in Server_session `*target_session`.</span></div>
<div class="line"><a id="l00280" name="l00280"></a><span class="lineno">  280</span><span class="comment">   * `on_done_func(Error_code())` is called on success.  `on_done_func(E)`, where `E` is a non-success</span></div>
<div class="line"><a id="l00281" name="l00281"></a><span class="lineno">  281</span><span class="comment">   * error code, is called otherwise.  In the latter case `*this` may continue operation, and further `async_accept()`s</span></div>
<div class="line"><a id="l00282" name="l00282"></a><span class="lineno">  282</span><span class="comment">   * may succeed.  See class doc header regarding error handling.</span></div>
<div class="line"><a id="l00283" name="l00283"></a><span class="lineno">  283</span><span class="comment">   *</span></div>
<div class="line"><a id="l00284" name="l00284"></a><span class="lineno">  284</span><span class="comment">   * Multiple async_accept() calls can be queued while no session-open is pending;</span></div>
<div class="line"><a id="l00285" name="l00285"></a><span class="lineno">  285</span><span class="comment">   * they will grab incoming connections in FIFO fashion as they arrive, but log-ins may race afterwards, resulting</span></div>
<div class="line"><a id="l00286" name="l00286"></a><span class="lineno">  286</span><span class="comment">   * in not-quite-FIFO emission via handler.  See class doc header regarding FIFO ordering.</span></div>
<div class="line"><a id="l00287" name="l00287"></a><span class="lineno">  287</span><span class="comment">   *</span></div>
<div class="line"><a id="l00288" name="l00288"></a><span class="lineno">  288</span><span class="comment">   * The aforementioned Server_session generated and move-assigned to `*target_session` on success shall</span></div>
<div class="line"><a id="l00289" name="l00289"></a><span class="lineno">  289</span><span class="comment">   * inherit `this-&gt;get_logger()` as its `-&gt;get_logger()`.</span></div>
<div class="line"><a id="l00290" name="l00290"></a><span class="lineno">  290</span><span class="comment">   *</span></div>
<div class="line"><a id="l00291" name="l00291"></a><span class="lineno">  291</span><span class="comment">   * `on_done_func()` shall be called from some unspecified thread, not the calling thread *and possibly concurrently</span></div>
<div class="line"><a id="l00292" name="l00292"></a><span class="lineno">  292</span><span class="comment">   * with other such completion handlers*.  Your implementation must be non-blocking.  Informally we recommend you</span></div>
<div class="line"><a id="l00293" name="l00293"></a><span class="lineno">  293</span><span class="comment">   * place the true on-event logic onto some task loop of your own; so ideally it would consist of essentially a</span></div>
<div class="line"><a id="l00294" name="l00294"></a><span class="lineno">  294</span><span class="comment">   * single `post(F)` statement of some kind.</span></div>
<div class="line"><a id="l00295" name="l00295"></a><span class="lineno">  295</span><span class="comment">   *</span></div>
<div class="line"><a id="l00296" name="l00296"></a><span class="lineno">  296</span><span class="comment">   * You must not call this from directly within a completion handler; else undefined behavior.</span></div>
<div class="line"><a id="l00297" name="l00297"></a><span class="lineno">  297</span><span class="comment">   *</span></div>
<div class="line"><a id="l00298" name="l00298"></a><span class="lineno">  298</span><span class="comment">   * #Error_code generated and passed to `on_done_func()`:</span></div>
<div class="line"><a id="l00299" name="l00299"></a><span class="lineno">  299</span><span class="comment">   * session::error::Code::S_OBJECT_SHUTDOWN_ABORTED_COMPLETION_HANDLER (destructor called, canceling all pending ops;</span></div>
<div class="line"><a id="l00300" name="l00300"></a><span class="lineno">  300</span><span class="comment">   * spiritually identical to `boost::asio::error::operation_aborted`),</span></div>
<div class="line"><a id="l00301" name="l00301"></a><span class="lineno">  301</span><span class="comment">   * other system codes most likely from `boost::asio::error` or `boost::system::errc` (but never</span></div>
<div class="line"><a id="l00302" name="l00302"></a><span class="lineno">  302</span><span class="comment">   * would-block), indicating the underlying transport::Native_socket_stream_acceptor is hosed for that specific reason,</span></div>
<div class="line"><a id="l00303" name="l00303"></a><span class="lineno">  303</span><span class="comment">   * those returned by transport::Native_socket_stream::remote_peer_process_credentials(),</span></div>
<div class="line"><a id="l00304" name="l00304"></a><span class="lineno">  304</span><span class="comment">   * those emitted by transport::struc::Channel::send(),</span></div>
<div class="line"><a id="l00305" name="l00305"></a><span class="lineno">  305</span><span class="comment">   * those emitted by transport::struc::Channel via on-error handler (most likely</span></div>
<div class="line"><a id="l00306" name="l00306"></a><span class="lineno">  306</span><span class="comment">   * transport::error::Code::S_RECEIVES_FINISHED_CANNOT_RECEIVE indicating graceful shutdown of opposing process</span></div>
<div class="line"><a id="l00307" name="l00307"></a><span class="lineno">  307</span><span class="comment">   * coincidentally during log-in procedure, prematurely ending session while it was starting),</span></div>
<div class="line"><a id="l00308" name="l00308"></a><span class="lineno">  308</span><span class="comment">   * error::Code::S_SERVER_MASTER_LOG_IN_REQUEST_CLIENT_APP_DISALLOWED_OR_UNKNOWN,</span></div>
<div class="line"><a id="l00309" name="l00309"></a><span class="lineno">  309</span><span class="comment">   * error::Code::S_SERVER_MASTER_LOG_IN_REQUEST_CLIENT_APP_INCONSISTENT_CREDS,</span></div>
<div class="line"><a id="l00310" name="l00310"></a><span class="lineno">  310</span><span class="comment">   * error::Code::S_SERVER_MASTER_LOG_IN_REQUEST_CONFIG_MISMATCH,</span></div>
<div class="line"><a id="l00311" name="l00311"></a><span class="lineno">  311</span><span class="comment">   * error::Code::S_INVALID_ARGUMENT (other side expected other async_accept() overload with</span></div>
<div class="line"><a id="l00312" name="l00312"></a><span class="lineno">  312</span><span class="comment">   * non-null `init_channels_by_cli_req` arg),</span></div>
<div class="line"><a id="l00313" name="l00313"></a><span class="lineno">  313</span><span class="comment">   * error::Code::S_SESSION_OPEN_CHANNEL_SERVER_CANNOT_PROCEED_RESOURCE_UNAVAILABLE (unable to acquire init-channel</span></div>
<div class="line"><a id="l00314" name="l00314"></a><span class="lineno">  314</span><span class="comment">   * resources -- as of this writing MQ-related ones).</span></div>
<div class="line"><a id="l00315" name="l00315"></a><span class="lineno">  315</span><span class="comment">   *</span></div>
<div class="line"><a id="l00316" name="l00316"></a><span class="lineno">  316</span><span class="comment">   * ### Error handling discussion ###</span></div>
<div class="line"><a id="l00317" name="l00317"></a><span class="lineno">  317</span><span class="comment">   * See class doc header regarding error handling, then come back here.</span></div>
<div class="line"><a id="l00318" name="l00318"></a><span class="lineno">  318</span><span class="comment">   * The last 3 specific #Error_code values listed can be considered, informally, individual misbehavior on</span></div>
<div class="line"><a id="l00319" name="l00319"></a><span class="lineno">  319</span><span class="comment">   * the part of the opposing client process.  While indicating potentially serious misconfiguration in the system,</span></div>
<div class="line"><a id="l00320" name="l00320"></a><span class="lineno">  320</span><span class="comment">   * surely to be investigated ASAP, it is conceivable to continue attempting further `async_accept()`s.</span></div>
<div class="line"><a id="l00321" name="l00321"></a><span class="lineno">  321</span><span class="comment">   *</span></div>
<div class="line"><a id="l00322" name="l00322"></a><span class="lineno">  322</span><span class="comment">   * Do note, though, that this is not a network client-server situation.  That is, probably, one should not expect</span></div>
<div class="line"><a id="l00323" name="l00323"></a><span class="lineno">  323</span><span class="comment">   * lots of -- or any -- such problems in a smoothly functioning IPC universe on a given production server machine.</span></div>
<div class="line"><a id="l00324" name="l00324"></a><span class="lineno">  324</span><span class="comment">   * E.g., there could be a security problem, or perhaps more likely there&#39;s a software</span></div>
<div class="line"><a id="l00325" name="l00325"></a><span class="lineno">  325</span><span class="comment">   * mismatch between client and server w/r/t their master App sets.  Your software deployment story may or may not</span></div>
<div class="line"><a id="l00326" name="l00326"></a><span class="lineno">  326</span><span class="comment">   * be designed to allow for this as a transient condition during software upgrades and such.</span></div>
<div class="line"><a id="l00327" name="l00327"></a><span class="lineno">  327</span><span class="comment">   *</span></div>
<div class="line"><a id="l00328" name="l00328"></a><span class="lineno">  328</span><span class="comment">   * @tparam Task_err</span></div>
<div class="line"><a id="l00329" name="l00329"></a><span class="lineno">  329</span><span class="comment">   *         Handler type matching signature of `flow::async::Task_asio_err`.</span></div>
<div class="line"><a id="l00330" name="l00330"></a><span class="lineno">  330</span><span class="comment">   * @param target_session</span></div>
<div class="line"><a id="l00331" name="l00331"></a><span class="lineno">  331</span><span class="comment">   *        Pointer to Server_session which shall be assigned an almost-PEER-state (open, requires</span></div>
<div class="line"><a id="l00332" name="l00332"></a><span class="lineno">  332</span><span class="comment">   *        Server_session::init_handlers() to enter PEER state) as `on_done_func()`</span></div>
<div class="line"><a id="l00333" name="l00333"></a><span class="lineno">  333</span><span class="comment">   *        is called.  Not touched on error.</span></div>
<div class="line"><a id="l00334" name="l00334"></a><span class="lineno">  334</span><span class="comment">   * @param on_done_func</span></div>
<div class="line"><a id="l00335" name="l00335"></a><span class="lineno">  335</span><span class="comment">   *        Completion handler.  See above.  The captured state in this function object shall be freed shortly upon</span></div>
<div class="line"><a id="l00336" name="l00336"></a><span class="lineno">  336</span><span class="comment">   *        its completed execution from the unspecified thread.</span></div>
<div class="line"><a id="l00337" name="l00337"></a><span class="lineno">  337</span><span class="comment">   */</span></div>
<div class="line"><a id="l00338" name="l00338"></a><span class="lineno">  338</span>  <span class="keyword">template</span>&lt;<span class="keyword">typename</span> Task_err&gt;</div>
<div class="line"><a id="l00339" name="l00339"></a><span class="lineno">  339</span>  <span class="keywordtype">void</span> <a class="code hl_function" href="classipc_1_1session_1_1Session__server.html#a13887cd64912bb5f5675e2817ff8435f">async_accept</a>(<a class="code hl_class" href="classipc_1_1session_1_1Server__session__mv.html">Server_session_obj</a>* target_session, Task_err&amp;&amp; on_done_func);</div>
<div class="line"><a id="l00340" name="l00340"></a><span class="lineno">  340</span><span class="comment"></span> </div>
<div class="line"><a id="l00341" name="l00341"></a><span class="lineno">  341</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00342" name="l00342"></a><span class="lineno">  342</span><span class="comment">   * Identical to the simpler async_accept() overload but offers added advanced capabilities: metadata exchange;</span></div>
<div class="line"><a id="l00343" name="l00343"></a><span class="lineno">  343</span><span class="comment">   * initial-channel opening.  The other overload is identical to</span></div>
<div class="line"><a id="l00344" name="l00344"></a><span class="lineno">  344</span><span class="comment">   * `async_accept(target_session, nullptr, nullptr, nullptr, ...N/A..., NO_OP_FUNC, on_done_func)`</span></div>
<div class="line"><a id="l00345" name="l00345"></a><span class="lineno">  345</span><span class="comment">   * (where `NO_OP_FUNC()` no-ops) and requires the opposing `sync_connect()` to similarly not use the corresponding</span></div>
<div class="line"><a id="l00346" name="l00346"></a><span class="lineno">  346</span><span class="comment">   * features.</span></div>
<div class="line"><a id="l00347" name="l00347"></a><span class="lineno">  347</span><span class="comment">   *</span></div>
<div class="line"><a id="l00348" name="l00348"></a><span class="lineno">  348</span><span class="comment">   * The advanced capabilities complement/mirror the ones on Client_session_mv::sync_connect() (advanced overload);</span></div>
<div class="line"><a id="l00349" name="l00349"></a><span class="lineno">  349</span><span class="comment">   * see its doc header first.  Then come back here.  The same mechanisms underly the following; but due</span></div>
<div class="line"><a id="l00350" name="l00350"></a><span class="lineno">  350</span><span class="comment">   * to client-server asymmetry the API is somewhat different.</span></div>
<div class="line"><a id="l00351" name="l00351"></a><span class="lineno">  351</span><span class="comment">   *</span></div>
<div class="line"><a id="l00352" name="l00352"></a><span class="lineno">  352</span><span class="comment">   * ### Server-&gt;client metadata exchange ###</span></div>
<div class="line"><a id="l00353" name="l00353"></a><span class="lineno">  353</span><span class="comment">   * Server may wish to provide information in some way, but without a structured channel -- or any channel -- yet</span></div>
<div class="line"><a id="l00354" name="l00354"></a><span class="lineno">  354</span><span class="comment">   * available, this provides an opportunity to do so in a structured way with a one-off message available at</span></div>
<div class="line"><a id="l00355" name="l00355"></a><span class="lineno">  355</span><span class="comment">   * session open, together with the opposing Session object itself.</span></div>
<div class="line"><a id="l00356" name="l00356"></a><span class="lineno">  356</span><span class="comment">   *</span></div>
<div class="line"><a id="l00357" name="l00357"></a><span class="lineno">  357</span><span class="comment">   * The metadata payload you may wish to load to emit to the opposing `Client_session::sync_connect()` may</span></div>
<div class="line"><a id="l00358" name="l00358"></a><span class="lineno">  358</span><span class="comment">   * depend on the following information available *during* the session-open procedure, namely upon receiving</span></div>
<div class="line"><a id="l00359" name="l00359"></a><span class="lineno">  359</span><span class="comment">   * (internally) the log-in request from the client side:</span></div>
<div class="line"><a id="l00360" name="l00360"></a><span class="lineno">  360</span><span class="comment">   *   - the Client_app that wishes to open the session;</span></div>
<div class="line"><a id="l00361" name="l00361"></a><span class="lineno">  361</span><span class="comment">   *   - how many init-channels the client is requesting be opened (see below);</span></div>
<div class="line"><a id="l00362" name="l00362"></a><span class="lineno">  362</span><span class="comment">   *   - the client-&gt;Server metadata (see below).</span></div>
<div class="line"><a id="l00363" name="l00363"></a><span class="lineno">  363</span><span class="comment">   *</span></div>
<div class="line"><a id="l00364" name="l00364"></a><span class="lineno">  364</span><span class="comment">   * Thus supply `Mdt_load_func mdt_load_func` arg which takes all 3 of these data, plus a blank</span></div>
<div class="line"><a id="l00365" name="l00365"></a><span class="lineno">  365</span><span class="comment">   * capnp `Mdt_payload` structure to fill; and loads the latter as desired.</span></div>
<div class="line"><a id="l00366" name="l00366"></a><span class="lineno">  366</span><span class="comment">   *</span></div>
<div class="line"><a id="l00367" name="l00367"></a><span class="lineno">  367</span><span class="comment">   * To omit using this feature do nothing in `mdt_load_func()`.  (The other async_accept() overload provides such</span></div>
<div class="line"><a id="l00368" name="l00368"></a><span class="lineno">  368</span><span class="comment">   * a no-op function.)  Suggest this value in that case: `[](auto&amp;&amp;...) {}`.</span></div>
<div class="line"><a id="l00369" name="l00369"></a><span class="lineno">  369</span><span class="comment">   *</span></div>
<div class="line"><a id="l00370" name="l00370"></a><span class="lineno">  370</span><span class="comment">   * ### Client-&gt;server metadata exchange ###</span></div>
<div class="line"><a id="l00371" name="l00371"></a><span class="lineno">  371</span><span class="comment">   * This is the reverse of the above.  Whatever the opposing client chose to supply as client-&gt;server metadata</span></div>
<div class="line"><a id="l00372" name="l00372"></a><span class="lineno">  372</span><span class="comment">   * shall be deserializable at `*mdt_from_cli_or_null` once (and if) `on_done_func(Error_code())` (successful</span></div>
<div class="line"><a id="l00373" name="l00373"></a><span class="lineno">  373</span><span class="comment">   * accept) fires.  If `mdt_from_cli_or_null` is null, the cli-&gt;srv metadata shall be ignored.</span></div>
<div class="line"><a id="l00374" name="l00374"></a><span class="lineno">  374</span><span class="comment">   *</span></div>
<div class="line"><a id="l00375" name="l00375"></a><span class="lineno">  375</span><span class="comment">   * ### Init-channels by server request ###</span></div>
<div class="line"><a id="l00376" name="l00376"></a><span class="lineno">  376</span><span class="comment">   * Once the session is open, open_channel() and the on-passive-open handler may be used to open channels at will.</span></div>
<div class="line"><a id="l00377" name="l00377"></a><span class="lineno">  377</span><span class="comment">   * In many use cases, however, a certain number of channels is required immediately before work can really begin</span></div>
<div class="line"><a id="l00378" name="l00378"></a><span class="lineno">  378</span><span class="comment">   * (and, frequently, no further channels are even needed).  For convenience (to avoid asynchrony/boiler-plate)</span></div>
<div class="line"><a id="l00379" name="l00379"></a><span class="lineno">  379</span><span class="comment">   * the init-channels feature will pre-open a requested # of channels making them available right away, together</span></div>
<div class="line"><a id="l00380" name="l00380"></a><span class="lineno">  380</span><span class="comment">   * with the freshly-open session -- to both sides.</span></div>
<div class="line"><a id="l00381" name="l00381"></a><span class="lineno">  381</span><span class="comment">   *</span></div>
<div class="line"><a id="l00382" name="l00382"></a><span class="lineno">  382</span><span class="comment">   * The server may request 0 or more init-channels.  They shall be opened and placed into</span></div>
<div class="line"><a id="l00383" name="l00383"></a><span class="lineno">  383</span><span class="comment">   * `*init_channels_by_srv_req`.  The number of channels requested may depend on the 3 piece of info outlined</span></div>
<div class="line"><a id="l00384" name="l00384"></a><span class="lineno">  384</span><span class="comment">   * above in &quot;Server-&gt;client metadata exchange.&quot;  Thus supply `N_init_channels_by_srv_req_func</span></div>
<div class="line"><a id="l00385" name="l00385"></a><span class="lineno">  385</span><span class="comment">   * n_init_channels_by_srv_req_func` arg which takes all 3 of these data and returns the `size_t` channel</span></div>
<div class="line"><a id="l00386" name="l00386"></a><span class="lineno">  386</span><span class="comment">   * count (possibly 0).  The resulting channels shall be loaded into `*init_channels_by_srv_req`</span></div>
<div class="line"><a id="l00387" name="l00387"></a><span class="lineno">  387</span><span class="comment">   * before successful `on_done_func()` execution.</span></div>
<div class="line"><a id="l00388" name="l00388"></a><span class="lineno">  388</span><span class="comment">   *</span></div>
<div class="line"><a id="l00389" name="l00389"></a><span class="lineno">  389</span><span class="comment">   * If and only if `n_init_channels_by_srv_req_func()` would always return 0, you may provide a</span></div>
<div class="line"><a id="l00390" name="l00390"></a><span class="lineno">  390</span><span class="comment">   * null `init_channels_by_srv_req`.  `n_init_channels_by_srv_req_func` will then be ignored.</span></div>
<div class="line"><a id="l00391" name="l00391"></a><span class="lineno">  391</span><span class="comment">   * Suggest this value in that case: `[](auto&amp;&amp;...) -&gt; size_t { return 0; }`</span></div>
<div class="line"><a id="l00392" name="l00392"></a><span class="lineno">  392</span><span class="comment">   *</span></div>
<div class="line"><a id="l00393" name="l00393"></a><span class="lineno">  393</span><span class="comment">   * ### Init-channels by client request ###</span></div>
<div class="line"><a id="l00394" name="l00394"></a><span class="lineno">  394</span><span class="comment">   * This is the reverse of the above.  The opposing side shall request 0 or more init-channels-by-client-request;</span></div>
<div class="line"><a id="l00395" name="l00395"></a><span class="lineno">  395</span><span class="comment">   * that number of channels shall be opened; and they will be placed into `*init_channels_by_cli_req` which shall</span></div>
<div class="line"><a id="l00396" name="l00396"></a><span class="lineno">  396</span><span class="comment">   * be `-&gt;resize()`d accordingly, once (and if) `on_done_func(Error_code())` (successful</span></div>
<div class="line"><a id="l00397" name="l00397"></a><span class="lineno">  397</span><span class="comment">   * connect) fires.</span></div>
<div class="line"><a id="l00398" name="l00398"></a><span class="lineno">  398</span><span class="comment">   *</span></div>
<div class="line"><a id="l00399" name="l00399"></a><span class="lineno">  399</span><span class="comment">   * `init_channels_by_srv_cli` being null is allowed, but only if the opposing server requests 0</span></div>
<div class="line"><a id="l00400" name="l00400"></a><span class="lineno">  400</span><span class="comment">   * init-channels-by-server-request.  Otherwise an error shall be emitted (see below).</span></div>
<div class="line"><a id="l00401" name="l00401"></a><span class="lineno">  401</span><span class="comment">   *</span></div>
<div class="line"><a id="l00402" name="l00402"></a><span class="lineno">  402</span><span class="comment">   * @tparam Task_err</span></div>
<div class="line"><a id="l00403" name="l00403"></a><span class="lineno">  403</span><span class="comment">   *         See other async_accept() overload.</span></div>
<div class="line"><a id="l00404" name="l00404"></a><span class="lineno">  404</span><span class="comment">   * @tparam N_init_channels_by_srv_req_func</span></div>
<div class="line"><a id="l00405" name="l00405"></a><span class="lineno">  405</span><span class="comment">   *         See above: function type matching signature</span></div>
<div class="line"><a id="l00406" name="l00406"></a><span class="lineno">  406</span><span class="comment">   *         `size_t F(const Client_app&amp;, size_t n_init_channels_by_cli_req, Mdt_reader_ptr&amp;&amp; mdt_from_cli)`.</span></div>
<div class="line"><a id="l00407" name="l00407"></a><span class="lineno">  407</span><span class="comment">   * @tparam Mdt_load_func</span></div>
<div class="line"><a id="l00408" name="l00408"></a><span class="lineno">  408</span><span class="comment">   *         See above: function type matching signature</span></div>
<div class="line"><a id="l00409" name="l00409"></a><span class="lineno">  409</span><span class="comment">   *         `void F(const Client_app&amp;, size_t n_init_channels_by_cli_req, Mdt_reader_ptr&amp;&amp; mdt_from_cli,</span></div>
<div class="line"><a id="l00410" name="l00410"></a><span class="lineno">  410</span><span class="comment">   *                 Mdt_builder* mdt_from_srv)`.</span></div>
<div class="line"><a id="l00411" name="l00411"></a><span class="lineno">  411</span><span class="comment">   * @param target_session</span></div>
<div class="line"><a id="l00412" name="l00412"></a><span class="lineno">  412</span><span class="comment">   *        See other async_accept() overload.</span></div>
<div class="line"><a id="l00413" name="l00413"></a><span class="lineno">  413</span><span class="comment">   * @param init_channels_by_srv_req</span></div>
<div class="line"><a id="l00414" name="l00414"></a><span class="lineno">  414</span><span class="comment">   *        See above: null or pointer to container of `Channel_obj` which shall be `.clear()`ed and replaced</span></div>
<div class="line"><a id="l00415" name="l00415"></a><span class="lineno">  415</span><span class="comment">   *        by a container of PEER-state `Channel_obj` on success the number being determined by</span></div>
<div class="line"><a id="l00416" name="l00416"></a><span class="lineno">  416</span><span class="comment">   *        `n_init_channels_by_srv_req_func()`.  null is treated as-if `n_init_channels_by_srv_req_func() == 0`</span></div>
<div class="line"><a id="l00417" name="l00417"></a><span class="lineno">  417</span><span class="comment">   *        for any input.</span></div>
<div class="line"><a id="l00418" name="l00418"></a><span class="lineno">  418</span><span class="comment">   * @param mdt_from_cli_or_null</span></div>
<div class="line"><a id="l00419" name="l00419"></a><span class="lineno">  419</span><span class="comment">   *        See above: null or pointer to `Reader` of metadata which shall be set for access on success.</span></div>
<div class="line"><a id="l00420" name="l00420"></a><span class="lineno">  420</span><span class="comment">   * @param init_channels_by_cli_req</span></div>
<div class="line"><a id="l00421" name="l00421"></a><span class="lineno">  421</span><span class="comment">   *        See above: null or pointer to container of `Channel_obj` which shall be `.clear()`ed and replaced</span></div>
<div class="line"><a id="l00422" name="l00422"></a><span class="lineno">  422</span><span class="comment">   *        by a container of PEER-state `Channel_obj` on success the number being specified by the opposing</span></div>
<div class="line"><a id="l00423" name="l00423"></a><span class="lineno">  423</span><span class="comment">   *        (client) side.  The number may be zero.  null is allowed if and only if the number is zero;</span></div>
<div class="line"><a id="l00424" name="l00424"></a><span class="lineno">  424</span><span class="comment">   *        otherwise error::Code::S_INVALID_ARGUMENT is emitted.</span></div>
<div class="line"><a id="l00425" name="l00425"></a><span class="lineno">  425</span><span class="comment">   * @param n_init_channels_by_srv_req_func</span></div>
<div class="line"><a id="l00426" name="l00426"></a><span class="lineno">  426</span><span class="comment">   *        See `N_init_channels_by_srv_req_func`.  Ignored on null `init_channels_by_srv_req`.</span></div>
<div class="line"><a id="l00427" name="l00427"></a><span class="lineno">  427</span><span class="comment">   * @param mdt_load_func</span></div>
<div class="line"><a id="l00428" name="l00428"></a><span class="lineno">  428</span><span class="comment">   *        See `Mdt_load_func`.</span></div>
<div class="line"><a id="l00429" name="l00429"></a><span class="lineno">  429</span><span class="comment">   * @param on_done_func</span></div>
<div class="line"><a id="l00430" name="l00430"></a><span class="lineno">  430</span><span class="comment">   *        See other async_accept() overload.  Note the above target (pointer) args are touched</span></div>
<div class="line"><a id="l00431" name="l00431"></a><span class="lineno">  431</span><span class="comment">   *        only if falsy #Error_code is passed to this handler.</span></div>
<div class="line"><a id="l00432" name="l00432"></a><span class="lineno">  432</span><span class="comment">   */</span></div>
<div class="line"><a id="l00433" name="l00433"></a><span class="lineno">  433</span>  <span class="keyword">template</span>&lt;<span class="keyword">typename</span> Task_err,</div>
<div class="line"><a id="l00434" name="l00434"></a><span class="lineno">  434</span>           <span class="keyword">typename</span> N_init_channels_by_srv_req_func, <span class="keyword">typename</span> Mdt_load_func&gt;</div>
<div class="line"><a id="l00435" name="l00435"></a><span class="lineno">  435</span>  <span class="keywordtype">void</span> <a class="code hl_function" href="classipc_1_1session_1_1Session__server.html#a13887cd64912bb5f5675e2817ff8435f">async_accept</a>(<a class="code hl_class" href="classipc_1_1session_1_1Server__session__mv.html">Server_session_obj</a>* target_session,</div>
<div class="line"><a id="l00436" name="l00436"></a><span class="lineno">  436</span>                    <a class="code hl_typedef" href="classipc_1_1session_1_1Session__server.html#a6dea741c32a771532a884ffbc0826bb3">Channels</a>* init_channels_by_srv_req,</div>
<div class="line"><a id="l00437" name="l00437"></a><span class="lineno">  437</span>                    <a class="code hl_typedef" href="classipc_1_1session_1_1Session__server.html#aa19b9057ac2d873b5989b6213a9e6f82">Mdt_reader_ptr</a>* mdt_from_cli_or_null,</div>
<div class="line"><a id="l00438" name="l00438"></a><span class="lineno">  438</span>                    <a class="code hl_typedef" href="classipc_1_1session_1_1Session__server.html#a6dea741c32a771532a884ffbc0826bb3">Channels</a>* init_channels_by_cli_req,</div>
<div class="line"><a id="l00439" name="l00439"></a><span class="lineno">  439</span>                    N_init_channels_by_srv_req_func&amp;&amp; n_init_channels_by_srv_req_func,</div>
<div class="line"><a id="l00440" name="l00440"></a><span class="lineno">  440</span>                    Mdt_load_func&amp;&amp; mdt_load_func,</div>
<div class="line"><a id="l00441" name="l00441"></a><span class="lineno">  441</span>                    Task_err&amp;&amp; on_done_func);</div>
<div class="line"><a id="l00442" name="l00442"></a><span class="lineno">  442</span><span class="comment"></span> </div>
<div class="line"><a id="l00443" name="l00443"></a><span class="lineno">  443</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00444" name="l00444"></a><span class="lineno">  444</span><span class="comment">   * Prints string representation to the given `ostream`.</span></div>
<div class="line"><a id="l00445" name="l00445"></a><span class="lineno">  445</span><span class="comment">   *</span></div>
<div class="line"><a id="l00446" name="l00446"></a><span class="lineno">  446</span><span class="comment">   * @param os</span></div>
<div class="line"><a id="l00447" name="l00447"></a><span class="lineno">  447</span><span class="comment">   *        Stream to which to write.</span></div>
<div class="line"><a id="l00448" name="l00448"></a><span class="lineno">  448</span><span class="comment">   */</span></div>
<div class="line"><a id="l00449" name="l00449"></a><span class="lineno">  449</span>  <span class="keywordtype">void</span> <a class="code hl_function" href="classipc_1_1session_1_1Session__server.html#a5fac8f78f1ff443db9b46788cae77fc4">to_ostream</a>(std::ostream* os) <span class="keyword">const</span>;</div>
<div class="line"><a id="l00450" name="l00450"></a><span class="lineno">  450</span> </div>
<div class="line"><a id="l00451" name="l00451"></a><span class="lineno">  451</span>  <span class="comment">// The LOG_*() macros don&#39;t see Log_context::get_log*() from base otherwise....</span></div>
<div class="line"><a id="l00452" name="l00452"></a><span class="lineno">  452</span>  <span class="keyword">using </span>Impl::get_logger;</div>
<div class="line"><a id="l00453" name="l00453"></a><span class="lineno">  453</span>  <span class="keyword">using </span>Impl::get_log_component;</div>
<div class="line"><a id="l00454" name="l00454"></a><span class="lineno">  454</span>}; <span class="comment">// class Session_server</span></div>
<div class="line"><a id="l00455" name="l00455"></a><span class="lineno">  455</span> </div>
<div class="line"><a id="l00456" name="l00456"></a><span class="lineno">  456</span><span class="comment">// Free functions: in *_fwd.hpp.</span></div>
<div class="line"><a id="l00457" name="l00457"></a><span class="lineno">  457</span> </div>
<div class="line"><a id="l00458" name="l00458"></a><span class="lineno">  458</span><span class="comment">// Template implementations.</span></div>
<div class="line"><a id="l00459" name="l00459"></a><span class="lineno">  459</span><span class="comment"></span> </div>
<div class="line"><a id="l00460" name="l00460"></a><span class="lineno">  460</span><span class="comment">/// Internally used macro; public API users should disregard (same deal as in struc/channel.hpp).</span></div>
<div class="line"><a id="l00461" name="l00461"></a><span class="lineno"><a class="line" href="ipc__session_2src_2ipc_2session_2session__server_8hpp.html#a1cf999dcc632f8556891d91597f13111">  461</a></span><span class="comment"></span><span class="preprocessor">#define TEMPLATE_SESSION_SERVER \</span></div>
<div class="line"><a id="l00462" name="l00462"></a><span class="lineno">  462</span><span class="preprocessor">  template&lt;schema::MqType S_MQ_TYPE_OR_NONE, bool S_TRANSMIT_NATIVE_HANDLES, typename Mdt_payload&gt;</span><span class="comment"></span></div>
<div class="line"><a id="l00463" name="l00463"></a><span class="lineno">  463</span><span class="comment">/// Internally used macro; public API users should disregard (same deal as in struc/channel.hpp).</span></div>
<div class="line"><a id="l00464" name="l00464"></a><span class="lineno"><a class="line" href="ipc__session_2src_2ipc_2session_2session__server_8hpp.html#a09f0b9ebdcfae182d71e2b2ae500eac9">  464</a></span><span class="comment"></span><span class="preprocessor">#define CLASS_SESSION_SERVER \</span></div>
<div class="line"><a id="l00465" name="l00465"></a><span class="lineno">  465</span><span class="preprocessor">  Session_server&lt;S_MQ_TYPE_OR_NONE, S_TRANSMIT_NATIVE_HANDLES, Mdt_payload&gt;</span></div>
<div class="line"><a id="l00466" name="l00466"></a><span class="lineno">  466</span> </div>
<div class="line"><a id="l00467" name="l00467"></a><span class="lineno">  467</span><a class="code hl_define" href="ipc__session_2src_2ipc_2session_2session__server_8hpp.html#a1cf999dcc632f8556891d91597f13111">TEMPLATE_SESSION_SERVER</a></div>
<div class="line"><a id="l00468" name="l00468"></a><span class="lineno"><a class="line" href="classipc_1_1session_1_1Session__server.html#a948ef778f6dd521e0f7632e9f7e06aa7">  468</a></span>CLASS_SESSION_SERVER::Session_server(flow::log::Logger* logger_ptr, <span class="keyword">const</span> <a class="code hl_struct" href="structipc_1_1session_1_1Server__app.html">Server_app</a>&amp; srv_app_ref_arg,</div>
<div class="line"><a id="l00469" name="l00469"></a><span class="lineno">  469</span>                                     <span class="keyword">const</span> <a class="code hl_typedef" href="structipc_1_1session_1_1Client__app.html#add718cbf6aa1d2abb26fbadcc974a7bd">Client_app::Master_set</a>&amp; cli_app_master_set_ref,</div>
<div class="line"><a id="l00470" name="l00470"></a><span class="lineno">  470</span>                                     <a class="code hl_typedef" href="namespaceipc.html#aa3192e586cc45d3e7c22463bf2760f89">Error_code</a>* err_code) :</div>
<div class="line"><a id="l00471" name="l00471"></a><span class="lineno">  471</span>  <a class="code hl_class" href="classipc_1_1session_1_1Session__server__impl.html">Impl</a>(logger_ptr, this, srv_app_ref_arg, cli_app_master_set_ref, err_code,</div>
<div class="line"><a id="l00472" name="l00472"></a><span class="lineno">  472</span>       [](const <a class="code hl_struct" href="structipc_1_1session_1_1Client__app.html">Client_app</a>&amp;) -&gt; <a class="code hl_typedef" href="namespaceipc.html#aa3192e586cc45d3e7c22463bf2760f89">Error_code</a> { return <a class="code hl_typedef" href="namespaceipc.html#aa3192e586cc45d3e7c22463bf2760f89">Error_code</a>(); }) <span class="comment">// Impl customization point: unused.</span></div>
<div class="line"><a id="l00473" name="l00473"></a><span class="lineno">  473</span>{</div>
<div class="line"><a id="l00474" name="l00474"></a><span class="lineno">  474</span>  <span class="comment">// OK then.</span></div>
<div class="line"><a id="l00475" name="l00475"></a><span class="lineno">  475</span>}</div>
<div class="line"><a id="l00476" name="l00476"></a><span class="lineno">  476</span> </div>
<div class="line"><a id="l00477" name="l00477"></a><span class="lineno">  477</span><a class="code hl_define" href="ipc__session_2src_2ipc_2session_2session__server_8hpp.html#a1cf999dcc632f8556891d91597f13111">TEMPLATE_SESSION_SERVER</a></div>
<div class="line"><a id="l00478" name="l00478"></a><span class="lineno">  478</span>CLASS_SESSION_SERVER::~Session_server() = <span class="keywordflow">default</span>; <span class="comment">// It&#39;s declared at all just to document it.  Forward to base.</span></div>
<div class="line"><a id="l00479" name="l00479"></a><span class="lineno">  479</span> </div>
<div class="line"><a id="l00480" name="l00480"></a><span class="lineno">  480</span><a class="code hl_define" href="ipc__session_2src_2ipc_2session_2session__server_8hpp.html#a1cf999dcc632f8556891d91597f13111">TEMPLATE_SESSION_SERVER</a></div>
<div class="line"><a id="l00481" name="l00481"></a><span class="lineno">  481</span><span class="keyword">template</span>&lt;<span class="keyword">typename</span> Task_err&gt;</div>
<div class="line"><a id="l00482" name="l00482"></a><span class="lineno"><a class="line" href="classipc_1_1session_1_1Session__server.html#a13887cd64912bb5f5675e2817ff8435f">  482</a></span><span class="keywordtype">void</span> CLASS_SESSION_SERVER::async_accept(<a class="code hl_class" href="classipc_1_1session_1_1Server__session__mv.html">Server_session_obj</a>* target_session, Task_err&amp;&amp; on_done_func)</div>
<div class="line"><a id="l00483" name="l00483"></a><span class="lineno">  483</span>{</div>
<div class="line"><a id="l00484" name="l00484"></a><span class="lineno">  484</span>  <span class="comment">// As advertised this overload always means:</span></div>
<div class="line"><a id="l00485" name="l00485"></a><span class="lineno">  485</span> </div>
<div class="line"><a id="l00486" name="l00486"></a><span class="lineno">  486</span>  <span class="keyword">auto</span> ignored_func = [](<span class="keyword">auto</span>&amp;&amp;...) -&gt; <span class="keywordtype">size_t</span> { <span class="keywordflow">return</span> 0; };</div>
<div class="line"><a id="l00487" name="l00487"></a><span class="lineno">  487</span>  <span class="keyword">auto</span> no_op_func = [](<span class="keyword">auto</span>&amp;&amp;...) {};</div>
<div class="line"><a id="l00488" name="l00488"></a><span class="lineno">  488</span> </div>
<div class="line"><a id="l00489" name="l00489"></a><span class="lineno">  489</span>  async_accept(target_session, <span class="keyword">nullptr</span>, <span class="keyword">nullptr</span>, <span class="keyword">nullptr</span>, std::move(ignored_func), std::move(no_op_func),</div>
<div class="line"><a id="l00490" name="l00490"></a><span class="lineno">  490</span>               std::move(on_done_func));</div>
<div class="line"><a id="l00491" name="l00491"></a><span class="lineno">  491</span> </div>
<div class="line"><a id="l00492" name="l00492"></a><span class="lineno">  492</span>  <span class="comment">/* @todo shm::classic::Session_server::async_accept() counterpart is a copy-paste of the above.</span></div>
<div class="line"><a id="l00493" name="l00493"></a><span class="lineno">  493</span><span class="comment">   * shm::arena_lend::jemalloc::Session_erver::async_accept() is too.</span></div>
<div class="line"><a id="l00494" name="l00494"></a><span class="lineno">  494</span><span class="comment">   * Maybe the design can be amended for greater code reuse/maintainability?  This isn&#39;t *too* bad but....</span></div>
<div class="line"><a id="l00495" name="l00495"></a><span class="lineno">  495</span><span class="comment">   *</span></div>
<div class="line"><a id="l00496" name="l00496"></a><span class="lineno">  496</span><span class="comment">   * Anyway, for now, if you change this then change the aforementioned forwarding code in the other</span></div>
<div class="line"><a id="l00497" name="l00497"></a><span class="lineno">  497</span><span class="comment">   * public `Session_server`s. */</span></div>
<div class="line"><a id="l00498" name="l00498"></a><span class="lineno">  498</span>}</div>
<div class="line"><a id="l00499" name="l00499"></a><span class="lineno">  499</span> </div>
<div class="line"><a id="l00500" name="l00500"></a><span class="lineno">  500</span><a class="code hl_define" href="ipc__session_2src_2ipc_2session_2session__server_8hpp.html#a1cf999dcc632f8556891d91597f13111">TEMPLATE_SESSION_SERVER</a></div>
<div class="line"><a id="l00501" name="l00501"></a><span class="lineno">  501</span><span class="keyword">template</span>&lt;<span class="keyword">typename</span> Task_err,</div>
<div class="line"><a id="l00502" name="l00502"></a><span class="lineno">  502</span>         <span class="keyword">typename</span> N_init_channels_by_srv_req_func, <span class="keyword">typename</span> Mdt_load_func&gt;</div>
<div class="line"><a id="l00503" name="l00503"></a><span class="lineno"><a class="line" href="classipc_1_1session_1_1Session__server.html#aee11a4a3e305bd3aa330f99fe5a9c509">  503</a></span><span class="keywordtype">void</span> CLASS_SESSION_SERVER::async_accept(<a class="code hl_class" href="classipc_1_1session_1_1Server__session__mv.html">Server_session_obj</a>* target_session,</div>
<div class="line"><a id="l00504" name="l00504"></a><span class="lineno">  504</span>                                        <a class="code hl_typedef" href="classipc_1_1session_1_1Session__server.html#a6dea741c32a771532a884ffbc0826bb3">Channels</a>* init_channels_by_srv_req,</div>
<div class="line"><a id="l00505" name="l00505"></a><span class="lineno">  505</span>                                        <a class="code hl_typedef" href="classipc_1_1session_1_1Session__server.html#aa19b9057ac2d873b5989b6213a9e6f82">Mdt_reader_ptr</a>* mdt_from_cli_or_null,</div>
<div class="line"><a id="l00506" name="l00506"></a><span class="lineno">  506</span>                                        <a class="code hl_typedef" href="classipc_1_1session_1_1Session__server.html#a6dea741c32a771532a884ffbc0826bb3">Channels</a>* init_channels_by_cli_req,</div>
<div class="line"><a id="l00507" name="l00507"></a><span class="lineno">  507</span>                                        N_init_channels_by_srv_req_func&amp;&amp; n_init_channels_by_srv_req_func,</div>
<div class="line"><a id="l00508" name="l00508"></a><span class="lineno">  508</span>                                        Mdt_load_func&amp;&amp; mdt_load_func,</div>
<div class="line"><a id="l00509" name="l00509"></a><span class="lineno">  509</span>                                        Task_err&amp;&amp; on_done_func)</div>
<div class="line"><a id="l00510" name="l00510"></a><span class="lineno">  510</span>{</div>
<div class="line"><a id="l00511" name="l00511"></a><span class="lineno">  511</span>  Impl::async_accept(target_session, init_channels_by_srv_req, mdt_from_cli_or_null, init_channels_by_cli_req,</div>
<div class="line"><a id="l00512" name="l00512"></a><span class="lineno">  512</span>                     std::move(n_init_channels_by_srv_req_func), std::move(mdt_load_func), std::move(on_done_func));</div>
<div class="line"><a id="l00513" name="l00513"></a><span class="lineno">  513</span>}</div>
<div class="line"><a id="l00514" name="l00514"></a><span class="lineno">  514</span> </div>
<div class="line"><a id="l00515" name="l00515"></a><span class="lineno">  515</span><a class="code hl_define" href="ipc__session_2src_2ipc_2session_2session__server_8hpp.html#a1cf999dcc632f8556891d91597f13111">TEMPLATE_SESSION_SERVER</a></div>
<div class="line"><a id="l00516" name="l00516"></a><span class="lineno"><a class="line" href="classipc_1_1session_1_1Session__server.html#a5fac8f78f1ff443db9b46788cae77fc4">  516</a></span><span class="keywordtype">void</span> CLASS_SESSION_SERVER::to_ostream(std::ostream* os)<span class="keyword"> const</span></div>
<div class="line"><a id="l00517" name="l00517"></a><span class="lineno">  517</span><span class="keyword"></span>{</div>
<div class="line"><a id="l00518" name="l00518"></a><span class="lineno">  518</span>  Impl::to_ostream(os);</div>
<div class="line"><a id="l00519" name="l00519"></a><span class="lineno">  519</span>}</div>
<div class="line"><a id="l00520" name="l00520"></a><span class="lineno">  520</span> </div>
<div class="line"><a id="l00521" name="l00521"></a><span class="lineno">  521</span><a class="code hl_define" href="ipc__session_2src_2ipc_2session_2session__server_8hpp.html#a1cf999dcc632f8556891d91597f13111">TEMPLATE_SESSION_SERVER</a></div>
<div class="line"><a id="l00522" name="l00522"></a><span class="lineno"><a class="line" href="classipc_1_1session_1_1Session__server.html#a4556b229bf2bfc3c9eb51af13c47de3d">  522</a></span>std::ostream&amp; <a class="code hl_function" href="classipc_1_1transport_1_1Native__socket__stream_1_1Impl.html#a33231b969171a9103cd0a319ea10278b">operator&lt;&lt;</a>(std::ostream&amp; os, <span class="keyword">const</span> <a class="code hl_define" href="ipc__session_2src_2ipc_2session_2session__server_8hpp.html#a09f0b9ebdcfae182d71e2b2ae500eac9">CLASS_SESSION_SERVER</a>&amp; val)</div>
<div class="line"><a id="l00523" name="l00523"></a><span class="lineno">  523</span>{</div>
<div class="line"><a id="l00524" name="l00524"></a><span class="lineno">  524</span>  val.to_ostream(&amp;os);</div>
<div class="line"><a id="l00525" name="l00525"></a><span class="lineno">  525</span>  <span class="keywordflow">return</span> os;</div>
<div class="line"><a id="l00526" name="l00526"></a><span class="lineno">  526</span>}</div>
<div class="line"><a id="l00527" name="l00527"></a><span class="lineno">  527</span> </div>
<div class="line"><a id="l00528" name="l00528"></a><span class="lineno">  528</span><span class="preprocessor">#undef CLASS_SESSION_SERVER</span></div>
<div class="line"><a id="l00529" name="l00529"></a><span class="lineno">  529</span><span class="preprocessor">#undef TEMPLATE_SESSION_SERVER</span></div>
<div class="line"><a id="l00530" name="l00530"></a><span class="lineno">  530</span> </div>
<div class="line"><a id="l00531" name="l00531"></a><span class="lineno">  531</span>} <span class="comment">// namespace ipc::session</span></div>
<div class="ttc" id="aclassipc_1_1session_1_1Server__session__mv_html"><div class="ttname"><a href="classipc_1_1session_1_1Server__session__mv.html">ipc::session::Server_session_mv&lt; Server_session_impl&lt; S_MQ_TYPE_OR_NONE, S_TRANSMIT_NATIVE_HANDLES, Mdt_payload &gt; &gt;</a></div></div>
<div class="ttc" id="aclassipc_1_1session_1_1Session__mv_html_af10f452e602e4ea7389c6a77dd9a0f88"><div class="ttname"><a href="classipc_1_1session_1_1Session__mv.html#af10f452e602e4ea7389c6a77dd9a0f88">ipc::session::Session_mv&lt; Server_session_impl&lt; S_MQ_TYPE_OR_NONE, S_TRANSMIT_NATIVE_HANDLES, Mdt_payload &gt; &gt;::Mdt_builder</a></div><div class="ttdeci">typename Impl::Mdt_builder Mdt_builder</div><div class="ttdoc">Implements Session API per contract.</div><div class="ttdef"><b>Definition:</b> <a href="ipc__session_2src_2ipc_2session_2session_8hpp_source.html#l00534">session.hpp:534</a></div></div>
<div class="ttc" id="aclassipc_1_1session_1_1Session__server__impl_html"><div class="ttname"><a href="classipc_1_1session_1_1Session__server__impl.html">ipc::session::Session_server_impl</a></div><div class="ttdoc">Internal class template comprising API/logic common to every Session_server variant,...</div><div class="ttdef"><b>Definition:</b> <a href="session__server__impl_8hpp_source.html#l00143">session_server_impl.hpp:146</a></div></div>
<div class="ttc" id="aclassipc_1_1session_1_1Session__server__impl_html_a86de1d5b7cae35d89827c3235e2b8d89"><div class="ttname"><a href="classipc_1_1session_1_1Session__server__impl.html#a86de1d5b7cae35d89827c3235e2b8d89">ipc::session::Session_server_impl&lt; Session_server&lt; S_MQ_TYPE_OR_NONE, S_TRANSMIT_NATIVE_HANDLES, Mdt_payload &gt;, Server_session&lt; S_MQ_TYPE_OR_NONE, S_TRANSMIT_NATIVE_HANDLES, Mdt_payload &gt; &gt;::Mdt_reader_ptr</a></div><div class="ttdeci">typename Server_session_obj::Mdt_reader_ptr Mdt_reader_ptr</div><div class="ttdoc">Short-hand for Session_mv::Mdt_reader_ptr.</div><div class="ttdef"><b>Definition:</b> <a href="session__server__impl_8hpp_source.html#l00157">session_server_impl.hpp:157</a></div></div>
<div class="ttc" id="aclassipc_1_1session_1_1Session__server__impl_html_a9ad5c6cbb1c9378d42ec5cd909389dc2"><div class="ttname"><a href="classipc_1_1session_1_1Session__server__impl.html#a9ad5c6cbb1c9378d42ec5cd909389dc2">ipc::session::Session_server_impl&lt; Session_server&lt; S_MQ_TYPE_OR_NONE, S_TRANSMIT_NATIVE_HANDLES, Mdt_payload &gt;, Server_session&lt; S_MQ_TYPE_OR_NONE, S_TRANSMIT_NATIVE_HANDLES, Mdt_payload &gt; &gt;::Channels</a></div><div class="ttdeci">typename Server_session_obj::Channels Channels</div><div class="ttdoc">Short-hand for Session_mv::Channels.</div><div class="ttdef"><b>Definition:</b> <a href="session__server__impl_8hpp_source.html#l00160">session_server_impl.hpp:160</a></div></div>
<div class="ttc" id="aclassipc_1_1session_1_1Session__server_html"><div class="ttname"><a href="classipc_1_1session_1_1Session__server.html">ipc::session::Session_server</a></div><div class="ttdoc">To be instantiated typically once in a given process, an object of this type asynchronously listens f...</div><div class="ttdef"><b>Definition:</b> <a href="ipc__session_2src_2ipc_2session_2session__server_8hpp_source.html#l00193">session_server.hpp:197</a></div></div>
<div class="ttc" id="aclassipc_1_1session_1_1Session__server_html_a13887cd64912bb5f5675e2817ff8435f"><div class="ttname"><a href="classipc_1_1session_1_1Session__server.html#a13887cd64912bb5f5675e2817ff8435f">ipc::session::Session_server::async_accept</a></div><div class="ttdeci">void async_accept(Server_session_obj *target_session, Task_err &amp;&amp;on_done_func)</div><div class="ttdoc">Asynchronously awaits for an opposing Client_session to request session establishment and calls on_do...</div><div class="ttdef"><b>Definition:</b> <a href="ipc__session_2src_2ipc_2session_2session__server_8hpp_source.html#l00482">session_server.hpp:482</a></div></div>
<div class="ttc" id="aclassipc_1_1session_1_1Session__server_html_a5fac8f78f1ff443db9b46788cae77fc4"><div class="ttname"><a href="classipc_1_1session_1_1Session__server.html#a5fac8f78f1ff443db9b46788cae77fc4">ipc::session::Session_server::to_ostream</a></div><div class="ttdeci">void to_ostream(std::ostream *os) const</div><div class="ttdoc">Prints string representation to the given ostream.</div><div class="ttdef"><b>Definition:</b> <a href="ipc__session_2src_2ipc_2session_2session__server_8hpp_source.html#l00516">session_server.hpp:516</a></div></div>
<div class="ttc" id="aclassipc_1_1session_1_1Session__server_html_a6dea741c32a771532a884ffbc0826bb3"><div class="ttname"><a href="classipc_1_1session_1_1Session__server.html#a6dea741c32a771532a884ffbc0826bb3">ipc::session::Session_server::Channels</a></div><div class="ttdeci">typename Impl::Channels Channels</div><div class="ttdoc">Short-hand for Session_mv::Channels.</div><div class="ttdef"><b>Definition:</b> <a href="ipc__session_2src_2ipc_2session_2session__server_8hpp_source.html#l00219">session_server.hpp:219</a></div></div>
<div class="ttc" id="aclassipc_1_1session_1_1Session__server_html_a86e894429b8568458aa20f3ba814434d"><div class="ttname"><a href="classipc_1_1session_1_1Session__server.html#a86e894429b8568458aa20f3ba814434d">ipc::session::Session_server::Mdt_builder</a></div><div class="ttdeci">typename Server_session_obj::Mdt_builder Mdt_builder</div><div class="ttdoc">Metadata builder type passed to mdt_load_func() in advanced async_accept() overload.</div><div class="ttdef"><b>Definition:</b> <a href="ipc__session_2src_2ipc_2session_2session__server_8hpp_source.html#l00216">session_server.hpp:216</a></div></div>
<div class="ttc" id="aclassipc_1_1session_1_1Session__server_html_a948ef778f6dd521e0f7632e9f7e06aa7"><div class="ttname"><a href="classipc_1_1session_1_1Session__server.html#a948ef778f6dd521e0f7632e9f7e06aa7">ipc::session::Session_server::Session_server</a></div><div class="ttdeci">Session_server(flow::log::Logger *logger_ptr, const Server_app &amp;srv_app_ref, const Client_app::Master_set &amp;cli_app_master_set_ref, Error_code *err_code=0)</div><div class="ttdoc">Constructor: immediately begins listening for incoming session-open attempts from allowed clients.</div><div class="ttdef"><b>Definition:</b> <a href="ipc__session_2src_2ipc_2session_2session__server_8hpp_source.html#l00468">session_server.hpp:468</a></div></div>
<div class="ttc" id="aclassipc_1_1session_1_1Session__server_html_aa19b9057ac2d873b5989b6213a9e6f82"><div class="ttname"><a href="classipc_1_1session_1_1Session__server.html#aa19b9057ac2d873b5989b6213a9e6f82">ipc::session::Session_server::Mdt_reader_ptr</a></div><div class="ttdeci">typename Impl::Mdt_reader_ptr Mdt_reader_ptr</div><div class="ttdoc">Short-hand for Session_mv::Mdt_reader_ptr.</div><div class="ttdef"><b>Definition:</b> <a href="ipc__session_2src_2ipc_2session_2session__server_8hpp_source.html#l00213">session_server.hpp:213</a></div></div>
<div class="ttc" id="aclassipc_1_1session_1_1Session__server_html_ae9c7c3132edba73bfad5d5a90722e813"><div class="ttname"><a href="classipc_1_1session_1_1Session__server.html#ae9c7c3132edba73bfad5d5a90722e813">ipc::session::Session_server::~Session_server</a></div><div class="ttdeci">~Session_server()</div><div class="ttdoc">Destroys this acceptor which will stop listening in the background and cancel any pending completion ...</div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1Native__socket__stream_1_1Impl_html_a33231b969171a9103cd0a319ea10278b"><div class="ttname"><a href="classipc_1_1transport_1_1Native__socket__stream_1_1Impl.html#a33231b969171a9103cd0a319ea10278b">ipc::transport::Native_socket_stream::Impl::operator&lt;&lt;</a></div><div class="ttdeci">std::ostream &amp; operator&lt;&lt;(std::ostream &amp;os, const Native_socket_stream::Impl &amp;val)</div><div class="ttdoc">Prints string representation of the given Native_socket_stream::Impl to the given ostream.</div><div class="ttdef"><b>Definition:</b> <a href="detail_2native__socket__stream__impl_8cpp_source.html#l00219">native_socket_stream_impl.cpp:219</a></div></div>
<div class="ttc" id="aipc__session_2src_2ipc_2session_2server__session_8hpp_html"><div class="ttname"><a href="ipc__session_2src_2ipc_2session_2server__session_8hpp.html">server_session.hpp</a></div></div>
<div class="ttc" id="aipc__session_2src_2ipc_2session_2session__server_8hpp_html_a09f0b9ebdcfae182d71e2b2ae500eac9"><div class="ttname"><a href="ipc__session_2src_2ipc_2session_2session__server_8hpp.html#a09f0b9ebdcfae182d71e2b2ae500eac9">CLASS_SESSION_SERVER</a></div><div class="ttdeci">#define CLASS_SESSION_SERVER</div><div class="ttdoc">Internally used macro; public API users should disregard (same deal as in struc/channel....</div><div class="ttdef"><b>Definition:</b> <a href="ipc__session_2src_2ipc_2session_2session__server_8hpp_source.html#l00464">session_server.hpp:464</a></div></div>
<div class="ttc" id="aipc__session_2src_2ipc_2session_2session__server_8hpp_html_a1cf999dcc632f8556891d91597f13111"><div class="ttname"><a href="ipc__session_2src_2ipc_2session_2session__server_8hpp.html#a1cf999dcc632f8556891d91597f13111">TEMPLATE_SESSION_SERVER</a></div><div class="ttdeci">#define TEMPLATE_SESSION_SERVER</div><div class="ttdoc">Internally used macro; public API users should disregard (same deal as in struc/channel....</div><div class="ttdef"><b>Definition:</b> <a href="ipc__session_2src_2ipc_2session_2session__server_8hpp_source.html#l00461">session_server.hpp:461</a></div></div>
<div class="ttc" id="anamespaceipc_1_1session_html"><div class="ttname"><a href="namespaceipc_1_1session.html">ipc::session</a></div><div class="ttdoc">Flow-IPC module providing the broad lifecycle and shared-resource organization – via the session conc...</div><div class="ttdef"><b>Definition:</b> <a href="app_8cpp_source.html#l00026">app.cpp:27</a></div></div>
<div class="ttc" id="anamespaceipc_html_aa3192e586cc45d3e7c22463bf2760f89"><div class="ttname"><a href="namespaceipc.html#aa3192e586cc45d3e7c22463bf2760f89">ipc::Error_code</a></div><div class="ttdeci">flow::Error_code Error_code</div><div class="ttdoc">Short-hand for flow::Error_code which is very common.</div><div class="ttdef"><b>Definition:</b> <a href="common_8hpp_source.html#l00298">common.hpp:298</a></div></div>
<div class="ttc" id="asession__server__impl_8hpp_html"><div class="ttname"><a href="session__server__impl_8hpp.html">session_server_impl.hpp</a></div></div>
<div class="ttc" id="astructipc_1_1session_1_1Client__app_html"><div class="ttname"><a href="structipc_1_1session_1_1Client__app.html">ipc::session::Client_app</a></div><div class="ttdoc">An App that is used as a client in at least one client-server IPC split.</div><div class="ttdef"><b>Definition:</b> <a href="app_8hpp_source.html#l00184">app.hpp:185</a></div></div>
<div class="ttc" id="astructipc_1_1session_1_1Client__app_html_add718cbf6aa1d2abb26fbadcc974a7bd"><div class="ttname"><a href="structipc_1_1session_1_1Client__app.html#add718cbf6aa1d2abb26fbadcc974a7bd">ipc::session::Client_app::Master_set</a></div><div class="ttdeci">boost::unordered_map&lt; std::string, Client_app &gt; Master_set</div><div class="ttdoc">Suggested type for storing master repository or all Client_appss. See App doc header for discussion.</div><div class="ttdef"><b>Definition:</b> <a href="app_8hpp_source.html#l00192">app.hpp:192</a></div></div>
<div class="ttc" id="astructipc_1_1session_1_1Server__app_html"><div class="ttname"><a href="structipc_1_1session_1_1Server__app.html">ipc::session::Server_app</a></div><div class="ttdoc">An App that is used as a server in at least one client-server IPC split.</div><div class="ttdef"><b>Definition:</b> <a href="app_8hpp_source.html#l00205">app.hpp:206</a></div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu May 2 2024 23:56:38 for Flow-IPC by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.4
</small></address>
</body>
</html>
